diff --git a/content/copilot/copilot-on-ghes/about-copilot-on-ghes.md b/content/copilot/copilot-on-ghes/about-copilot-on-ghes.md index f6923518d459..1c9c87f0daed 100644 --- a/content/copilot/copilot-on-ghes/about-copilot-on-ghes.md +++ b/content/copilot/copilot-on-ghes/about-copilot-on-ghes.md @@ -28,7 +28,7 @@ Your {% data variables.product.prodname_enterprise %} license also entitles you You can use your cloud-hosted enterprise account to assign {% data variables.product.prodname_copilot_short %} licenses to users and configure policies for {% data variables.product.prodname_copilot_short %}. Users will then be able to authenticate to their cloud account to use {% data variables.product.prodname_copilot_short %} in local clients such as {% data variables.copilot.copilot_cli_short %}. -{% data variables.product.prodname_copilot_short %} will have access to locally checked-out code and files. Users can configure their local [GitHub MCP server](https://github.com/github/github-mcp-server?tab=readme-ov-file#local-github-mcp-server) so that {% data variables.product.prodname_copilot_short %} can connect to your instance and perform actions like opening issues or pull requests. +{% data variables.product.prodname_copilot_short %} will have access to locally checked-out code and files. To access remote data, users can also sign in to {% data variables.product.prodname_ghe_server %} in the {% data variables.copilot.github_copilot_app_short %} or configure their local [GitHub MCP server](https://github.com/github/github-mcp-server?tab=readme-ov-file#local-github-mcp-server). See [AUTOTITLE](/copilot/copilot-on-ghes/sign-in-on-copilot-app). If you enable license sync with {% data variables.product.prodname_github_connect %}, each individual will only consume one {% data variables.product.prodname_enterprise %} license, even with an account on both cloud and server. See [AUTOTITLE](/admin/configuring-settings/configuring-github-connect/about-github-connect). diff --git a/content/copilot/copilot-on-ghes/index.md b/content/copilot/copilot-on-ghes/index.md index 514d8a702459..221103270520 100644 --- a/content/copilot/copilot-on-ghes/index.md +++ b/content/copilot/copilot-on-ghes/index.md @@ -10,5 +10,6 @@ redirect_from: children: - about-copilot-on-ghes - set-up-copilot-cli + - sign-in-on-copilot-app --- diff --git a/content/copilot/copilot-on-ghes/sign-in-on-copilot-app.md b/content/copilot/copilot-on-ghes/sign-in-on-copilot-app.md new file mode 100644 index 000000000000..d143d3ac8ce0 --- /dev/null +++ b/content/copilot/copilot-on-ghes/sign-in-on-copilot-app.md @@ -0,0 +1,21 @@ +--- +title: Signing in to GitHub Enterprise Server in the GitHub Copilot app +shortTitle: Sign in on Copilot app +intro: 'Sign in with your {% data variables.product.prodname_ghe_server %} account to work with repositories, pull requests, and issues from the {% data variables.copilot.github_copilot_app_short %}.' +versions: + ghes: '*' +contentType: how-tos +--- + +If you use {% data variables.product.prodname_ghe_server %}, you can sign in on the {% data variables.copilot.github_copilot_app_short %} to work with repositories, pull requests, and issues hosted on the {% data variables.product.prodname_ghe_server %} instance. + +When you set up the app, you must first sign in to an account on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.enterprise.data_residency_site %}. Then, you can add your {% data variables.product.prodname_ghe_server %} account: + +1. Click {% octicon "gear" aria-label="Settings" %} to open the Settings dialog. +1. In the sidebar, click **Accounts**. +1. Click **Add account**, then click **{% data variables.product.prodname_ghe_server %}**. +1. Follow the prompts to open your browser and authorize the app. + +## Next step + +To start making requests, ensure you're also signed in to a cloud account with a {% data variables.product.prodname_copilot_short %} license. Alternatively, to configure your own model provider, see [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/github-copilot-app/add-llm-models). diff --git a/content/copilot/get-started/quickstart-copilot-app.md b/content/copilot/get-started/quickstart-copilot-app.md index 841f343a1e02..c2e54517a415 100644 --- a/content/copilot/get-started/quickstart-copilot-app.md +++ b/content/copilot/get-started/quickstart-copilot-app.md @@ -44,9 +44,13 @@ Download and install the {% data variables.copilot.github_copilot_app %} for you 1. Open the {% data variables.copilot.github_copilot_app %}. 1. Click **Sign in to {% data variables.product.github %}** and follow the prompts to authenticate. - If you use {% data variables.product.prodname_ghe_cloud %} with data residency, choose **Use GitHub Enterprise** and enter your `*.ghe.com` hostname when prompted. {% data variables.product.prodname_ghe_server %} is not supported by the {% data variables.copilot.github_copilot_app %}. + * If you use {% data variables.enterprise.data_residency %}, choose **{% data variables.product.prodname_ghe_cloud %}** and enter your `*.ghe.com` hostname when prompted. + * If you work on {% data variables.product.prodname_ghe_server %}, sign in with a cloud account first. You can add your {% data variables.product.prodname_ghe_server %} account later to access repositories, pull requests, and issues for that account. + 1. If you do not have a {% data variables.product.prodname_copilot_short %} plan, choose whether to sign up for a plan or continue with your own model provider. - * If you choose to use your own model provider, select a provider, enter any required credentials, then click **Save and continue**. + + If you choose to use your own model provider, select a provider, enter any required credentials, then click **Save and continue**. + 1. When prompted, select one or more repositories based on your recent {% data variables.product.github %} activity. You can also add a local folder or repository, or skip this step and add repositories later. 1. Choose a theme, then complete onboarding to open the app. @@ -60,6 +64,8 @@ To work on code, you need at least one repository or local folder connected to t * **Add {% data variables.product.github %} repository** — Browse and clone a repository from {% data variables.product.github %}. * **Clone repository** — Clone from a Git URL for repositories hosted outside {% data variables.product.github %} (for example, on Azure DevOps) or for private repositories without app access. +To add repositories hosted on {% data variables.product.prodname_ghe_server %}, sign in to your account. See [AUTOTITLE](/enterprise-server@latest/copilot/copilot-on-ghes/sign-in-on-copilot-app). + ## Making your first code changes 1. In the sidebar, next to **Sessions**, click {% octicon "plus" aria-label="New" %}, then select the connected repository or folder under "Start session in." diff --git a/content/copilot/tutorials/roll-out-at-scale/enable-developers/copilot-app-for-teams.md b/content/copilot/tutorials/roll-out-at-scale/enable-developers/copilot-app-for-teams.md index 233ed01711d1..ede96e18e945 100644 --- a/content/copilot/tutorials/roll-out-at-scale/enable-developers/copilot-app-for-teams.md +++ b/content/copilot/tutorials/roll-out-at-scale/enable-developers/copilot-app-for-teams.md @@ -57,8 +57,10 @@ After you configure access and policies, ask each developer to: 1. Visit the [download page for the {% data variables.copilot.github_copilot_app %}](https://github.com/features/ai/github-app). 1. Download and install the app for their operating system. -1. Open the app. -1. Click **Sign in to {% data variables.product.github %}** and follow the prompts to authenticate. +1. Open the app and sign in to {% data variables.product.github %}. + + * Developers should sign in to the account where they receive their {% data variables.product.prodname_copilot_short %} license. + * If your repositories are hosted on {% data variables.product.prodname_ghe_server %}, developers should add their {% data variables.product.prodname_ghe_server %} account once they've set up the app. 1. Select the pilot repository when prompted. Participants can also add an existing local repository or clone the repository later. 1. If the pilot task requires an MCP server, in the app sidebar, click **Customize**, then **MCP**. Install an approved server required for the task. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields.md index aac2816d059a..d67d8e257563 100644 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields.md +++ b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields.md @@ -1,7 +1,7 @@ --- title: About issue fields in projects shortTitle: About issue fields -intro: 'Learn how to use organization-level issue fields in your projects to track structured metadata like priority, effort, and dates.' +intro: 'Learn how to use issue fields in your projects to track structured metadata like priority, effort, and dates.' versions: feature: issue-fields contentType: tutorials @@ -9,11 +9,11 @@ category: - Manage project items and fields --- -Issue fields are organization-level fields that provide consistent, typed metadata across all repositories. Unlike project custom fields, issue fields are defined once at the organization level and are available on every issue and in every project across the organization. For more information on creating and managing issue fields, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization). +Issue fields are organization-level or user-level fields that provide consistent, typed metadata across repositories owned by that organization or user. Unlike project custom fields, issue fields are defined once at the organization or user level and are available on issues owned by that organization or user and in projects owned by that organization or user. For more information on creating and managing issue fields, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields). ## Issue fields in public and internal projects -Only fields with **Public** visibility appear in public and internal projects. Organization-only fields are hidden. For details on configuring field visibility and how visibility changes affect projects, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization#setting-field-visibility). +Only fields with **Public** visibility appear in public and internal projects. Restricted fields are hidden. For details on configuring field visibility and how visibility changes affect projects, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields#setting-field-visibility). ## Adding an issue field to a project @@ -22,7 +22,7 @@ To display issue field values in a project: 1. Open a project and select a view using the table layout. 1. Click {% octicon "plus" aria-label="Add field" %} in the table header. 1. Click **Add field**. -1. Select one or more issue fields from the list of available fields in the organization. +1. Select one or more issue fields from the list of available fields. 1. Click **Add**. The issue field appears as a column in the table view. @@ -36,7 +36,7 @@ To remove an issue field from a project: 1. In the left sidebar, select the issue field you want to remove. 1. Click **Remove field**. -Removing an issue field from a project does not delete the field or its values from the organization. The field can be re-added at any time. +Removing an issue field from a project does not delete the field or its values. The field can be re-added at any time. ## Editing issue field values in a project @@ -50,11 +50,11 @@ You can also use issue fields to group by column on the board layout. ## Charts and insights -Issue fields are available as data sources in project charts. You can create charts that group or segment by issue field values to visualize trends across your organization. +Issue fields are available as data sources in project charts. You can create charts that group or segment by issue field values to visualize trends. ## Limits Projects support up to 50 fields in total. Issue fields and system fields count toward this limit. If a project is already at the field limit, you need to remove existing fields before issue fields can be added. > [!NOTE] -> Issue fields only apply to issues owned by the same organization. If a project contains pull requests, draft issues, or issues from another organization, issue field columns show empty cells for those items. +> Issue fields only apply to issues owned by the same organization or user. If a project contains pull requests, draft issues, or issues from another organization or user, issue field columns show empty cells for those items. diff --git a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-the-issue-type-field.md b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-the-issue-type-field.md index b4ee5d50ee8e..7304ece97559 100644 --- a/content/issues/planning-and-tracking-with-projects/understanding-fields/about-the-issue-type-field.md +++ b/content/issues/planning-and-tracking-with-projects/understanding-fields/about-the-issue-type-field.md @@ -11,9 +11,9 @@ category: - Manage project items and fields --- -If your organization uses issue types, you can enable the "Type" field on your projects to see the issue type and how the issue is classified in your organization, such as a bug, task, or feature. +If your organization or user account uses issue types, you can enable the "Type" field on your projects to see the issue type and how the issue is classified, such as a bug, task, or feature. -For more about issue types, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization). +For more about issue types, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types). ## Enabling the Type field diff --git a/content/issues/tracking-your-work-with-issues/learning-about-issues/about-issues.md b/content/issues/tracking-your-work-with-issues/learning-about-issues/about-issues.md index 56118cc83576..82eb3374ea21 100644 --- a/content/issues/tracking-your-work-with-issues/learning-about-issues/about-issues.md +++ b/content/issues/tracking-your-work-with-issues/learning-about-issues/about-issues.md @@ -38,7 +38,7 @@ You can define blocking relationships between issues using issue dependencies. I You can add metadata to your issues, including issue types, labels and milestones to organize your issues. -See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization), [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels) and [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones). +See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types), [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels) and [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones). ## About integration with {% data variables.product.github %} diff --git a/content/issues/tracking-your-work-with-issues/using-issues/adding-and-managing-issue-fields.md b/content/issues/tracking-your-work-with-issues/using-issues/adding-and-managing-issue-fields.md index 318c414ffafa..2624129da14f 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/adding-and-managing-issue-fields.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/adding-and-managing-issue-fields.md @@ -49,7 +49,7 @@ Issue fields appear in the right-hand sidebar of issues, alongside system fields ## Pinned fields -If your organization administrator has pinned fields to specific issue types, those fields automatically appear in the sidebar and the issue creation modal when you create or view an issue of that type. You do not need to manually add pinned fields. +If fields have been pinned to a specific issue type by your organization administrator or by you for your user-owned repositories, those fields automatically appear in the sidebar and the issue creation modal when you create or view an issue of that type. You do not need to manually add pinned fields. ## Viewing field changes in the timeline @@ -59,16 +59,16 @@ When a field value is changed, the update is recorded in the issue timeline. The * Who made the change * When the change was made -Timeline events for fields set to "Organization only" visibility are hidden from users who are not organization members or collaborators. +Timeline events for fields set to "Restricted" visibility are visible only to organization members and repository collaborators in organization-owned repositories, or to the repository owner and collaborators in user-owned repositories. ## Field visibility -Organization administrators can set each field's visibility to "Organization only" or "Public". This affects what you see: +Organization administrators and user account owners can set each field's visibility to "Restricted" or "Public". This affects what you see: -* If a field is set to **Organization only**, it is only visible to organization members and repository collaborators with at least read access. If you are not a member or collaborator, the field does not appear in the issue sidebar, timeline, or search suggestions. +* If a field is set to **Restricted**, it is only visible to organization members and repository collaborators with at least read access in organization-owned repositories, or to the repository owner and collaborators with at least read access in user-owned repositories. If you do not have access to the field, it does not appear in the issue sidebar, timeline, or search suggestions. * If a field is set to **Public**, it is visible to anyone viewing the issue. -For more information about configuring visibility, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization#setting-field-visibility). +For more information about configuring visibility, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields#setting-field-visibility). ## Using issue fields in projects @@ -88,7 +88,7 @@ For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/usi Issue fields have full REST and GraphQL API support. You can automate field management, set values programmatically, and integrate with external tools. -* **Managing fields**: Create, update, and delete organization-level fields. See the [Organization issue fields REST API](/rest/orgs/issue-fields). +* **Managing fields**: Create, update, and delete fields. See the [issue fields REST API](/rest/orgs/issue-fields). * **Using fields**: Get, set, and clear field values on individual issues. See the [Issue field values REST API](/rest/issues/issue-field-values). * **GraphQL**: Issue field types and mutations are also available via GraphQL. See the [`IssueFields` union](/graphql/reference/issues#union-issuefields), [issue field objects](/graphql/reference/issues#object-issuefieldtext) (such as `IssueFieldText`, `IssueFieldSingleSelect`, `IssueFieldNumber`, and `IssueFieldDate`), and [mutations](/graphql/reference/issues#mutation-createissuefield) (such as `createIssueField`, `updateIssueField`, and `setIssueFieldValue`). diff --git a/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md b/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md index e9f03d80939b..b1ec9e82cf63 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests.md @@ -150,7 +150,7 @@ Examples: * `field.story-points:>5` -- find issues with a number field value greater than 5 * `field.priority:high,medium` -- find issues with priority set to "high" or "medium" -For more information about managing issue fields, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization). +For more information about managing issue fields, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields). {% endif %} diff --git a/content/issues/tracking-your-work-with-issues/using-issues/index.md b/content/issues/tracking-your-work-with-issues/using-issues/index.md index 01c9d58b61fb..e5fba325d733 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/index.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/index.md @@ -18,7 +18,7 @@ children: - /creating-a-branch-for-an-issue - /linking-a-pull-request-to-an-issue - /about-slash-commands - - /managing-issue-types-in-an-organization - - /managing-issue-fields-in-your-organization + - /managing-issue-types + - /managing-issue-fields - /adding-and-managing-issue-fields --- diff --git a/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization.md b/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields.md similarity index 72% rename from content/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization.md rename to content/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields.md index 94c665bfe551..014f24ecff8c 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields.md @@ -1,22 +1,23 @@ --- -title: Managing issue fields in your organization -intro: 'You can create and manage custom issue fields to collect structured metadata across all issues in your organization.' +title: Managing issue fields +intro: 'You can create and manage custom issue fields to collect structured metadata across all issues in your organization-owned repositories or user-owned repositories.' redirect_from: - /issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization + - /issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-your-organization versions: feature: issue-fields contentType: concepts shortTitle: 'Managing issue fields' -permissions: 'Organization owners can create and manage issue fields.' +permissions: 'Organization owners and user account owners can create and manage issue fields.' category: - Triage and organize issues --- -Issue fields let you add structured metadata to issues across your organization. Instead of relying on labels or free-text workarounds, you can create fields like priority, effort, impact, or any custom category your team needs. Fields are defined at the organization level and apply across all repositories in your organization. +Issue fields let you add structured metadata to issues across your repositories. Instead of relying on labels or free-text workarounds, you can create fields like priority, effort, impact, or any custom category your team needs. Fields are defined at the organization or user level and apply across all repositories. ## About issue field types -You can create up to 25 issue fields per organization. The following field types are available: +You can create up to 25 issue fields. The following field types are available: * **Single-select**: choose one option from a predefined list. Options can have names, descriptions, and colors. * **Text**: capture free-form text. URLs are automatically detected and displayed as clickable links. @@ -25,7 +26,7 @@ You can create up to 25 issue fields per organization. The following field types ## Default fields -When issue fields are enabled for your organization, four default fields are created automatically: +When issue fields are enabled, four default fields are created automatically: * **Priority** (single-select): Urgent, High, Medium, Low * **Effort** (single-select): High, Medium, Low @@ -48,8 +49,7 @@ These default fields are fully customizable. You can edit their names, descripti ## Creating an issue field -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} +1. Under your organization name or user profile, click {% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings. 1. In the "Planning" section of the sidebar, click **Issue fields**. 1. Click **New field**. 1. Under "Field name", type the name of your new field. @@ -60,14 +60,13 @@ These default fields are fully customizable. You can edit their names, descripti * Optionally, to set a color for an option, click {% octicon "kebab-horizontal" aria-label="open option menu" %} next to the option, click **Edit option**, choose a color, and click **Save**. * Repeat to add more options. 1. Under "Field Visibility", choose one of the following: - * **Permissions**: choose who can see the field and its value. Options are **Organization only** (default) or **Public**. This setting only applies to issues in public repositories. + * **Permissions**: choose who can see the field and its value. Options are **Restricted** (default) or **Public**. This setting only applies to issues in public repositories. * **Pin to types**: click {% octicon "pencil" aria-label="edit pinning" %} to choose which issue types show this field in the issue viewer and creator. Select one or more issue types, or "Issues without a type". Fields that are not pinned and have no value will stay hidden in the issue viewer and creator. 1. Click **Create**. ## Editing an issue field -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} +1. Under your organization name or user profile, click {% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings. 1. In the "Planning" section of the sidebar, click **Issue fields**. 1. To the right of the field you want to edit, click {% octicon "kebab-horizontal" aria-label="open field options" %}. 1. Click **Edit** and make your changes. @@ -77,21 +76,19 @@ These default fields are fully customizable. You can edit their names, descripti When you delete an issue field, all values set on issues for that field are permanently removed. -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} +1. Under your organization name or user profile, click {% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings. 1. In the "Planning" section of the sidebar, click **Issue fields**. 1. To the right of the field you want to delete, click {% octicon "kebab-horizontal" aria-label="open field options" %}. 1. Click **Delete** and confirm the deletion. > [!TIP] -> If you don't want to use issue fields, you can delete all default fields from your org settings. This removes them from all issues in your organization. You can re-create fields at any time. +> If you don't want to use issue fields, you can delete all default fields from your settings. This removes them from all issues. You can re-create fields at any time. ## Reordering issue fields The order of pinned fields is managed per issue type. The field order determines how fields appear in the issue sidebar and the issue creation modal. -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} +1. Under your organization name or user profile, click {% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings. 1. In the "Planning" section of the sidebar, click **Issue types**. 1. Click the issue type you want to reorder fields for. 1. Under "Pinned issue fields", drag fields to reorder them. @@ -101,8 +98,7 @@ The order of pinned fields is managed per issue type. The field order determines You can associate issue fields with specific issue types so that only the most relevant fields appear when creating or viewing issues of that type. For example, you can pin "Severity" to bugs and "Impact" to features. -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} +1. Under your organization name or user profile, click {% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings. 1. In the "Planning" section of the sidebar, click **Issue fields**. 1. Click the field you want to pin. 1. Under "Pin to types", click {% octicon "pencil" aria-label="edit pinning" %} and select the issue types this field should appear on. @@ -117,29 +113,28 @@ If a field is not appearing on your issues, check that it is pinned to the relev ## Setting field visibility -For organizations with public repositories, you can control whether each issue field is visible to everyone or only to organization members and collaborators. +For organizations or user profiles with public repositories, you can control whether each issue field is visible to everyone or only to members, repository owners, and collaborators. -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} +1. Under your organization name or user profile, click {% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings. 1. In the "Planning" section of the sidebar, click **Issue fields**. 1. To the right of the field, click {% octicon "kebab-horizontal" aria-label="open field options" %}. 1. Click **Edit**. 1. Under "Field Visibility", choose one of the following: - * **Organization only**: the field is visible only to organization members and repository collaborators with at least read access. + * **Restricted**: the field is visible only to organization members and repository collaborators with at least read access in organization-owned repositories, or to the repository owner and collaborators with at least read access in personally owned repositories. * **Public**: the field is visible to anyone viewing the issue. 1. Click **Save**. -By default, all new and existing fields are set to "Organization only". Visibility settings are enforced across the web UI, API, issue timeline events, and search suggestions. +By default, all new and existing fields are set to "Restricted". Visibility settings are enforced across the web UI, API, issue timeline events, and search suggestions. ## Issue fields and projects -Issue fields are available in any project across your organization, including public and internal projects. For details on adding, removing, and editing issue fields in projects, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields). +Issue fields are available in any project across your organization or user profile, including public and internal projects. For details on adding, removing, and editing issue fields in projects, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields/about-issue-fields). ### Visibility in public and internal projects -Only fields with **Public** visibility are available in public and internal projects. Fields set to **Organization only** are not displayed. When adding fields to a public project, only public-visibility fields appear in the add-field dialog. +Only fields with **Public** visibility are available in public and internal projects. Fields set to **Restricted** are not displayed. When adding fields to a public project, only public-visibility fields appear in the add-field dialog. -If a field's visibility is changed from "Public" to "Organization only" while in use in a public project, the field is automatically removed from the project. To restore it, change the field's visibility back to "Public." +If a field's visibility is changed from "Public" to "Restricted" while in use in a public project, the field is automatically removed from the project. To restore it, change the field's visibility back to "Public." ### Migrating from project fields to issue fields @@ -158,7 +153,7 @@ Projects support up to 50 fields in total, and issue fields and system fields co | Resource | Limit | |----------|-------| -| Issue fields per organization | 25 | +| Issue fields | 25 | | Options per single-select field | 100 | | Pinned fields per issue type | 10 | | Total fields in a project (including issue fields and system fields) | 50 | diff --git a/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization.md b/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-types.md similarity index 64% rename from content/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization.md rename to content/issues/tracking-your-work-with-issues/using-issues/managing-issue-types.md index 1988efa983b9..14c115ef48e7 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/managing-issue-types.md @@ -1,28 +1,30 @@ --- -title: Managing issue types in an organization -intro: Learn about issue types and how to manage them in your organization. +title: Managing issue types +intro: Learn about issue types and how to manage them. redirect_from: - /issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization + - /issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization versions: fpt: '*' ghec: '*' ghes: '*' shortTitle: Managing issue types -permissions: Organization owners can modify issue types. +permissions: Organization owners and user account owners can modify issue types. contentType: concepts category: - Triage and organize issues --- -You can use issue types to classify and manage different types of issues across your organization. You can create up to {% data variables.projects.issue_type_limit %} issue types that your organization members can apply to issues, making it easier for you and your members to find issues and plan work. +You can use issue types to classify and manage different types of issues across your organization and user-owned repositories. You can create up to {% data variables.projects.issue_type_limit %} issue types that you can apply to issues, making it easier for you and your members to find issues and plan work. -Default issue types are included in every organization, but these can edited, disabled, or deleted. The default types are task, bug, and feature. +Default issue types are included in every organization and user account, but these can edited, disabled, or deleted. The default types are task, bug, and feature. When you add an issue type to an issue, the type will be shown on any lists of issues and in the issues themselves. You can filter and search by issue type and use issue types when creating filters and views in your projects. See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests#filtering-by-issue-type) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects#filtering-by-issue-type). ## Adding an issue type -{% data reusables.issues.access-issue-types-settings %} +1. Under your organization name or user profile, click {% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings. +1. {% data reusables.user-settings.code-planning-automation %} select {% octicon "table" aria-hidden="true" aria-label="table" %} Planning, then click Issue types. 1. On the right side of the page, click **Create new type**. 1. Under "Type name", type the name of your new issue type. 1. Under "Description", to help other people understand the purpose of your new issue type, type a description. @@ -35,7 +37,8 @@ You can change the name, description, and color of your issue types. You can also choose to disable or delete an issue type. If you disable an issue type, it will not be shown and it won't be possible to set an issue to that type, but if you later decide to enable the issue type, it will be displayed again on any issues previously set to the issue type. If you delete an issue type, it is permanently removed. -{% data reusables.issues.access-issue-types-settings %} +1. Under your organization name or user profile, click {% octicon "gear" aria-hidden="true" aria-label="gear" %} Settings. +1. {% data reusables.user-settings.code-planning-automation %} select {% octicon "table" aria-hidden="true" aria-label="table" %} Planning, then click Issue types. 1. To the right of the issue type you want to make changes to, click {% octicon "kebab-horizontal" aria-label="open type options" %}.  diff --git a/content/rest/users/index.md b/content/rest/users/index.md index 54d8d1ca4e17..8970e63a0049 100644 --- a/content/rest/users/index.md +++ b/content/rest/users/index.md @@ -18,6 +18,8 @@ children: - /emails - /followers - /gpg-keys + - /issue-fields + - /issue-types - /keys - /social-accounts - /ssh-signing-keys diff --git a/content/rest/users/issue-fields.md b/content/rest/users/issue-fields.md new file mode 100644 index 000000000000..832c83ad83f3 --- /dev/null +++ b/content/rest/users/issue-fields.md @@ -0,0 +1,14 @@ +--- +title: REST API endpoints for issue fields +shortTitle: Issue fields +intro: Use the REST API to create and manage issue fields for the authenticated user. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +autogenerated: rest +allowTitleToDifferFromFilename: true +category: + - Manage users and activity +--- + + diff --git a/content/rest/users/issue-types.md b/content/rest/users/issue-types.md new file mode 100644 index 000000000000..dd2e87194b38 --- /dev/null +++ b/content/rest/users/issue-types.md @@ -0,0 +1,14 @@ +--- +title: REST API endpoints for issue types +shortTitle: Issue types +intro: Use the REST API to create and manage issue types for the authenticated user. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +autogenerated: rest +allowTitleToDifferFromFilename: true +category: + - Manage users and activity +--- + + diff --git a/data/release-notes/enterprise-server/3-19/15.yml b/data/release-notes/enterprise-server/3-19/15.yml index e5e5470f9c1b..3161679fc9ce 100644 --- a/data/release-notes/enterprise-server/3-19/15.yml +++ b/data/release-notes/enterprise-server/3-19/15.yml @@ -2,11 +2,11 @@ date: '2026-11-10' sections: security_fixes: - | - **CRITICAL**: The Ruby Active Storage component was updated to address the file-read and remote code execution vulnerability CVE-2026-66066. + **CRITICAL**: The Ruby Active Storage component was updated to address the file-read and remote code execution vulnerability [CVE-2026-66066](https://www.cve.org/CVERecord?id=CVE-2026-66066). - | - **HIGH**: Updated Git to include fixes that address CVE-2026-105437, CVE-2026-111760, CVE-2026-113408, CVE-2026-114466, CVE-2026-114467, and CVE-2026-114469. + **HIGH**: Updated Git to include fixes that address [CVE-2026-105437](https://www.cve.org/CVERecord?id=CVE-2026-105437), [CVE-2026-111760](https://www.cve.org/CVERecord?id=CVE-2026-111760), [CVE-2026-113408](https://www.cve.org/CVERecord?id=CVE-2026-113408), [CVE-2026-114466](https://www.cve.org/CVERecord?id=CVE-2026-114466), [CVE-2026-114467](https://www.cve.org/CVERecord?id=CVE-2026-114467), and [CVE-2026-114469](https://www.cve.org/CVERecord?id=CVE-2026-114469). - | - **MODERATE**: The Brotli compression library bundled with the GitHub application was updated to address CVE-2026-111497. + **MODERATE**: The Brotli compression library bundled with the GitHub application was updated to address [CVE-2026-111497](https://www.cve.org/CVERecord?id=CVE-2026-111497). - | Security updates have been applied to Go, OpenSSL, and Ubuntu system packages, including SQLite, across targeted main and bundled container images. These updates partially address [CVE-2026-111943](https://www.cve.org/CVERecord?id=CVE-2026-111943), [CVE-2025-15467](https://www.cve.org/CVERecord?id=CVE-2025-15467), and [CVE-2025-6965](https://www.cve.org/CVERecord?id=CVE-2025-6965); remaining components will be updated in a future release. - | diff --git a/data/release-notes/enterprise-server/3-20/11.yml b/data/release-notes/enterprise-server/3-20/11.yml index 903ace7689ac..386449b1731b 100644 --- a/data/release-notes/enterprise-server/3-20/11.yml +++ b/data/release-notes/enterprise-server/3-20/11.yml @@ -2,11 +2,11 @@ date: '2026-11-10' sections: security_fixes: - | - **CRITICAL**: The Ruby Active Storage component was updated to address the file-read and remote code execution vulnerability CVE-2026-66066. + **CRITICAL**: The Ruby Active Storage component was updated to address the file-read and remote code execution vulnerability [CVE-2026-66066](https://www.cve.org/CVERecord?id=CVE-2026-66066). - | - **HIGH**: Updated Git to include fixes that address CVE-2026-105437, CVE-2026-111760, CVE-2026-113408, CVE-2026-114466, CVE-2026-114467, and CVE-2026-114469. + **HIGH**: Updated Git to include fixes that address [CVE-2026-105437](https://www.cve.org/CVERecord?id=CVE-2026-105437), [CVE-2026-111760](https://www.cve.org/CVERecord?id=CVE-2026-111760), [CVE-2026-113408](https://www.cve.org/CVERecord?id=CVE-2026-113408), [CVE-2026-114466](https://www.cve.org/CVERecord?id=CVE-2026-114466), [CVE-2026-114467](https://www.cve.org/CVERecord?id=CVE-2026-114467), and [CVE-2026-114469](https://www.cve.org/CVERecord?id=CVE-2026-114469). - | - **MODERATE**: The Brotli compression library bundled with the GitHub application was updated to address CVE-2026-111497. + **MODERATE**: The Brotli compression library bundled with the GitHub application was updated to address [CVE-2026-111497](https://www.cve.org/CVERecord?id=CVE-2026-111497). - | Security updates have been applied to Go, OpenSSL, and Ubuntu system packages, including SQLite, across targeted main and bundled container images. These updates partially address [CVE-2026-111943](https://www.cve.org/CVERecord?id=CVE-2026-111943), [CVE-2025-15467](https://www.cve.org/CVERecord?id=CVE-2025-15467), and [CVE-2025-6965](https://www.cve.org/CVERecord?id=CVE-2025-6965); remaining components will be updated in a future release. - | diff --git a/data/release-notes/enterprise-server/3-21/9.yml b/data/release-notes/enterprise-server/3-21/9.yml index bb85f9921e07..a04e0e78afe5 100644 --- a/data/release-notes/enterprise-server/3-21/9.yml +++ b/data/release-notes/enterprise-server/3-21/9.yml @@ -2,11 +2,11 @@ date: '2026-11-10' sections: security_fixes: - | - **CRITICAL**: The Ruby Active Storage component was updated to address the file-read and remote code execution vulnerability CVE-2026-66066. + **CRITICAL**: The Ruby Active Storage component was updated to address the file-read and remote code execution vulnerability [CVE-2026-66066](https://www.cve.org/CVERecord?id=CVE-2026-66066). - | - **HIGH**: Updated Git to include fixes that address CVE-2026-105437, CVE-2026-111760, CVE-2026-113408, CVE-2026-114466, CVE-2026-114467, and CVE-2026-114469. + **HIGH**: Updated Git to include fixes that address [CVE-2026-105437](https://www.cve.org/CVERecord?id=CVE-2026-105437), [CVE-2026-111760](https://www.cve.org/CVERecord?id=CVE-2026-111760), [CVE-2026-113408](https://www.cve.org/CVERecord?id=CVE-2026-113408), [CVE-2026-114466](https://www.cve.org/CVERecord?id=CVE-2026-114466), [CVE-2026-114467](https://www.cve.org/CVERecord?id=CVE-2026-114467), and [CVE-2026-114469](https://www.cve.org/CVERecord?id=CVE-2026-114469). - | - **MODERATE**: The Brotli compression library bundled with the GitHub application was updated to address CVE-2026-111497. + **MODERATE**: The Brotli compression library bundled with the GitHub application was updated to address [CVE-2026-111497](https://www.cve.org/CVERecord?id=CVE-2026-111497). - | Security updates have been applied to Go, OpenSSL, and Ubuntu system packages, including SQLite, across targeted main and bundled container images. These updates partially address [CVE-2026-111943](https://www.cve.org/CVERecord?id=CVE-2026-111943), [CVE-2025-15467](https://www.cve.org/CVERecord?id=CVE-2025-15467), and [CVE-2025-6965](https://www.cve.org/CVERecord?id=CVE-2025-6965); remaining components will be updated in a future release. - | diff --git a/data/release-notes/enterprise-server/3-22/4.yml b/data/release-notes/enterprise-server/3-22/4.yml index 7bc97822a29c..737a13066ea5 100644 --- a/data/release-notes/enterprise-server/3-22/4.yml +++ b/data/release-notes/enterprise-server/3-22/4.yml @@ -2,11 +2,11 @@ date: '2026-11-10' sections: security_fixes: - | - **CRITICAL**: The Ruby Active Storage component was updated to address the file-read and remote code execution vulnerability CVE-2026-66066. + **CRITICAL**: The Ruby Active Storage component was updated to address the file-read and remote code execution vulnerability [CVE-2026-66066](https://www.cve.org/CVERecord?id=CVE-2026-66066). - | - **HIGH**: Updated Git to include fixes that address CVE-2026-105437, CVE-2026-111760, CVE-2026-113408, CVE-2026-114466, CVE-2026-114467, and CVE-2026-114469. + **HIGH**: Updated Git to include fixes that address [CVE-2026-105437](https://www.cve.org/CVERecord?id=CVE-2026-105437), [CVE-2026-111760](https://www.cve.org/CVERecord?id=CVE-2026-111760), [CVE-2026-113408](https://www.cve.org/CVERecord?id=CVE-2026-113408), [CVE-2026-114466](https://www.cve.org/CVERecord?id=CVE-2026-114466), [CVE-2026-114467](https://www.cve.org/CVERecord?id=CVE-2026-114467), and [CVE-2026-114469](https://www.cve.org/CVERecord?id=CVE-2026-114469). - | - **MODERATE**: The Brotli compression library bundled with the GitHub application was updated to address CVE-2026-111497. + **MODERATE**: The Brotli compression library bundled with the GitHub application was updated to address [CVE-2026-111497](https://www.cve.org/CVERecord?id=CVE-2026-111497). - | Security updates have been applied to Go, OpenSSL, and Ubuntu system packages, including SQLite, across targeted main and bundled container images. These updates partially address [CVE-2026-111943](https://www.cve.org/CVERecord?id=CVE-2026-111943), [CVE-2025-15467](https://www.cve.org/CVERecord?id=CVE-2025-15467), and [CVE-2025-6965](https://www.cve.org/CVERecord?id=CVE-2025-6965); remaining components will be updated in a future release. - | diff --git a/data/ui.yml b/data/ui.yml index 131b00dd395f..eafc22fc000d 100644 --- a/data/ui.yml +++ b/data/ui.yml @@ -78,10 +78,6 @@ search: query_too_large: Sorry, your question is too long. Please try shortening it and asking again. asked_too_many_times: Sorry, you've asked too many questions in a short time period. Please wait a few minutes and try again. invalid_query: Sorry, I'm unable to answer that question. Please try asking a different question. - response: - copy_code: Copy code to clipboard - copy_code_lang: Copy {language} code to clipboard - copied_code: Copied! failure: general_title: There was an error loading search results. ai_title: There was an error loading Copilot. diff --git a/eslint.config.ts b/eslint.config.ts index db3e4e689651..8af8481cc5a5 100644 --- a/eslint.config.ts +++ b/eslint.config.ts @@ -253,6 +253,7 @@ export default [ 'src/landings/components/ProductSelectionCard.tsx', 'src/release-notes/components/GHESReleaseNotes.tsx', 'src/landings/components/journey/JourneyLearningTracks.tsx', + 'src/frame/components/ui/UnderlineNav/UnderlineNav.tsx', ], rules: { 'jsx-a11y/no-redundant-roles': [ diff --git a/src/archives/README.md b/src/archives/README.md index dc7220f47765..002d57fc386b 100644 --- a/src/archives/README.md +++ b/src/archives/README.md @@ -22,6 +22,7 @@ The system acts as a reverse proxy for specific URL paths. - Fetches the content from the external host. - Rewrites HTML (e.g., fixing image paths, injecting new headers). - Handles redirects defined in the archived version's `redirects.json`. + - Adds `/archived-build-manifest-stub.js` to archived Next.js pages. Archives never load a real `_buildManifest.js`, so without the stub, client-side navigation (for example, the language and version pickers) waits about 4 seconds before falling back to a full page load. - `archived-enterprise-versions-assets.ts`: Proxies static assets (CSS, JS, fonts) from the archive host. - `archived-asset-redirects.ts`: Maps legacy asset paths to modern equivalents where possible. - **`lib/`** diff --git a/src/archives/middleware/archived-enterprise-versions.ts b/src/archives/middleware/archived-enterprise-versions.ts index fddc9e8e5726..b7942c3eb012 100644 --- a/src/archives/middleware/archived-enterprise-versions.ts +++ b/src/archives/middleware/archived-enterprise-versions.ts @@ -1,4 +1,4 @@ -import type { Response, NextFunction } from 'express' +import type { Request, Response, NextFunction } from 'express' import { fetchWithRetry, readBodyWithTimeout } from '@/frame/lib/fetch-utils' import statsd, { adaptForTimer } from '@/observability/lib/statsd' @@ -16,7 +16,11 @@ import { isLanguageInArchivedVersion } from '@/archives/lib/archived-languages' import { getDoubledLanguagePrefixRedirect } from '@/archives/lib/doubled-language-prefix' import { setFastlySurrogateKey, SURROGATE_ENUMS } from '@/frame/middleware/set-fastly-surrogate-key' import { readCompressedJsonFileFallbackLazily } from '@/frame/lib/read-json-file' -import { archivedCacheControl, languageCacheControl } from '@/frame/middleware/cache-control' +import { + archivedCacheControl, + defaultCacheControl, + languageCacheControl, +} from '@/frame/middleware/cache-control' import { pathLanguagePrefixed, languagePrefixPathRegex } from '@/languages/lib/languages-server' import { languages as allLanguages } from '@/languages/lib/languages' import getRedirect, { splitPathByLanguage } from '@/redirects/lib/get-redirect' @@ -34,6 +38,37 @@ const OLD_DEVELOPER_SITE_CONTAINER = `${OLD_PUBLIC_AZURE_BLOB_URL}/developer-sit // Archived enterprise repositories use https://github.github.com/docs-ghes-2.10. const ENTERPRISE_GH_PAGES_URL_PREFIX = 'https://github.github.com/docs-ghes-' +// Archived pages never load a real _buildManifest.js, so Next's router.push waits about +// 4 seconds for a manifest before it falls back to a full page load. An empty manifest +// makes route lookup fail right away, so client-side navigation becomes an immediate +// full page load. CSP blocks inline scripts, so the stub is served from this origin. +export const ARCHIVED_BUILD_MANIFEST_STUB_PATH = '/archived-build-manifest-stub.js' +const ARCHIVED_BUILD_MANIFEST_STUB = [ + 'self.__BUILD_MANIFEST={__rewrites:{beforeFiles:[],afterFiles:[],fallback:[]},sortedPages:[]};', + 'self.__BUILD_MANIFEST_CB&&self.__BUILD_MANIFEST_CB();', + 'self.__SSG_MANIFEST=new Set();', + 'self.__SSG_MANIFEST_CB&&self.__SSG_MANIFEST_CB();', +].join('\n') + +export function archivedBuildManifestStub(req: Request, res: Response, next: NextFunction) { + if (req.path !== ARCHIVED_BUILD_MANIFEST_STUB_PATH) return next() + if (req.method !== 'GET' && req.method !== 'HEAD') return next() + defaultCacheControl(res) + res.type('application/javascript') + res.send(ARCHIVED_BUILD_MANIFEST_STUB) +} + +// Only Next.js archives need the stub. Some keep a _buildManifest.js tag, but +// archived-enterprise-versions-assets answers it with an empty 204, so they need it too. +// It goes first in
so it runs before Next's deferred scripts. +export function injectArchivedBuildManifestStub(body: string): string { + if (!body.includes('id="__NEXT_DATA__"')) return body + return body.replace( + /]*)?>/i, + (headTag) => `${headTag}`, + ) +} + type ArchivedRedirects = { [url: string]: string | null } @@ -264,7 +299,9 @@ export default async function archivedEnterpriseVersions( } if (r.status === 200) { - const body = await readBodyWithTimeout(r, () => r.text(), timeoutConfiguration.response) + const body = injectArchivedBuildManifestStub( + await readBodyWithTimeout(r, () => r.text(), timeoutConfiguration.response), + ) const [, withoutLanguagePath] = splitByLanguage(req.path) const isDeveloperPage = withoutLanguagePath?.startsWith( `/enterprise/${requestedVersion}/developer`, diff --git a/src/archives/tests/deprecated-enterprise-versions.ts b/src/archives/tests/deprecated-enterprise-versions.ts index 772e93f5def0..b0a0cc92aeac 100644 --- a/src/archives/tests/deprecated-enterprise-versions.ts +++ b/src/archives/tests/deprecated-enterprise-versions.ts @@ -3,6 +3,10 @@ import { describe, expect, test, vi } from 'vitest' import enterpriseServerReleases from '@/versions/lib/enterprise-server-releases' import { get, getDOM } from '@/tests/helpers/e2etest' import { SURROGATE_ENUMS } from '@/frame/middleware/set-fastly-surrogate-key' +import { + ARCHIVED_BUILD_MANIFEST_STUB_PATH, + injectArchivedBuildManifestStub, +} from '@/archives/middleware/archived-enterprise-versions' describe('enterprise deprecation', () => { vi.setConfig({ testTimeout: 60 * 1000 }) @@ -382,3 +386,42 @@ describe('JS and CSS assets', () => { expect(result.headers['cache-control']).toMatch(/max-age=[1-9]/) }) }) + +describe('archived build manifest stub', () => { + vi.setConfig({ testTimeout: 60 * 1000 }) + + const stubTag = `` + + test('injects the stub first in for Next.js archives', () => { + const html = + '' + + '' + expect(injectArchivedBuildManifestStub(html)).toBe(html.replace('', `${stubTag}`)) + }) + + test('does not inject the stub into non-Next.js archives', () => { + const html = '{props.children}
- } else {
- text = text.replace(/\n$/, '')
- }
-
- // The copy button announces the language when the code fence exposes one.
- const language = props.className?.startsWith('language-')
- ? props.className.replace('language-', '')
- : ''
-
- const [isCopied, copyToClipboard] = useCopyClipboard(text, {
- successDuration: 2000,
- })
-
- const getAriaLabel = () => {
- if (isCopied) {
- return t('search.ai.response.copied_code')
- }
- return t('search.ai.response.copy_code_lang').replace(
- '{language}',
- language ? `${language} ` : '',
- )
- }
-
- return (
- {props.children}
- Enum value RESTRICTED was added to enum IssueFieldVisibility
Field pinnedIssueFields was added to object type Repository
Argument after: String added to field Repository.pinnedIssueFields
Argument before: String added to field Repository.pinnedIssueFields
Argument first: Int added to field Repository.pinnedIssueFields
Argument last: Int added to field Repository.pinnedIssueFields
Argument orderBy: PinnedIssueFieldOrder (with default value) added to field Repository.pinnedIssueFields
Field issueFields was added to object type User
Argument after: String added to field User.issueFields
Argument before: String added to field User.issueFields
Argument first: Int added to field User.issueFields
Argument last: Int added to field User.issueFields
Argument orderBy: IssueFieldOrder (with default value) added to field User.issueFields
Field issueTypes was added to object type User
Argument after: String added to field User.issueTypes
Argument before: String added to field User.issueTypes
Argument first: Int added to field User.issueTypes
Argument last: Int added to field User.issueTypes
Argument orderBy: IssueTypeOrder (with default value) added to field User.issueTypes
Field pinnedIssueFields was added to object type User
Argument after: String added to field User.pinnedIssueFields
Argument before: String added to field User.pinnedIssueFields
Argument first: Int added to field User.pinnedIssueFields
Argument last: Int added to field User.pinnedIssueFields
Argument orderBy: PinnedIssueFieldOrder (with default value) added to field User.pinnedIssueFields
On member IssueFieldVisibility.ORG_ONLY:ORG_ONLY will be removed. Use RESTRICTED instead. Effective 2027-04-01.
All.
" + "description": "Visible to everyone who can see the issue.
" }, { "name": "ORG_ONLY", - "description": "Org Only.
" + "description": "Visible to members of the owning organization and, where repository context is supplied, collaborators on that repository.
", + "isDeprecated": true, + "deprecationReason": "ORG_ONLY will be removed. Use RESTRICTED instead. Removal on 2027-04-01 UTC.
Visible to the owner and to collaborators on the repository the field is read through.
" } ], "category": "issues" @@ -11760,10 +11766,11 @@ }, { "name": "ownerId", - "description": "The ID of the organization where the issue field will be created.
", + "description": "The ID of the organization or user where the issue field will be created.
", "type": "ID!", "id": "id", - "href": "/graphql/reference/other#scalar-id" + "href": "/graphql/reference/other#scalar-id", + "isDeprecated": false }, { "name": "visibility", @@ -11949,7 +11956,7 @@ }, { "name": "isEnabled", - "description": "Whether or not the issue type is enabled on the org level.
", + "description": "Whether or not the issue type is enabled.
", "type": "Boolean!", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" @@ -11963,10 +11970,11 @@ }, { "name": "ownerId", - "description": "The ID for the organization on which the issue type is created.
", + "description": "The ID of the owner on which the issue type is created.
", "type": "ID!", "id": "id", - "href": "/graphql/reference/other#scalar-id" + "href": "/graphql/reference/other#scalar-id", + "isDeprecated": false } ], "category": "issues" @@ -13899,7 +13907,7 @@ }, { "name": "isEnabled", - "description": "Whether or not the issue type is enabled for the organization.
", + "description": "Whether or not the issue type is enabled.
", "type": "Boolean", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" diff --git a/src/graphql/data/fpt/schema-projects.json b/src/graphql/data/fpt/schema-projects.json index b05ab337f94b..4e761da3f4b9 100644 --- a/src/graphql/data/fpt/schema-projects.json +++ b/src/graphql/data/fpt/schema-projects.json @@ -2102,14 +2102,14 @@ }, { "name": "isIssueField", - "description": "Returns true if this field is associated with an organization issue field.
", + "description": "Returns true if this field is associated with an issue field.
", "type": "Boolean!", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" }, { "name": "issueField", - "description": "The organization issue field associated with this project field, if any.
", + "description": "The issue field associated with this project field, if any.
", "type": "IssueFields", "id": "issuefields", "href": "/graphql/reference/issues#union-issuefields" @@ -3535,7 +3535,7 @@ }, { "name": "isIssueField", - "description": "Returns true if this field is associated with an organization issue field.
", + "description": "Returns true if this field is associated with an issue field.
", "type": "Boolean!", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" @@ -3696,14 +3696,14 @@ }, { "name": "isIssueField", - "description": "Returns true if this field is associated with an organization issue field.
", + "description": "Returns true if this field is associated with an issue field.
", "type": "Boolean!", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" }, { "name": "issueField", - "description": "The organization issue field associated with this project field, if any.
", + "description": "The issue field associated with this project field, if any.
", "type": "IssueFields", "id": "issuefields", "href": "/graphql/reference/issues#union-issuefields" @@ -3851,14 +3851,14 @@ }, { "name": "isIssueField", - "description": "Returns true if this field is associated with an organization issue field.
", + "description": "Returns true if this field is associated with an issue field.
", "type": "Boolean!", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" }, { "name": "issueField", - "description": "The organization issue field associated with this project field, if any.
", + "description": "The issue field associated with this project field, if any.
", "type": "IssueFields", "id": "issuefields", "href": "/graphql/reference/issues#union-issuefields" @@ -5189,7 +5189,7 @@ }, { "name": "isIssueField", - "description": "Returns true if this field is associated with an organization issue field.
", + "description": "Returns true if this field is associated with an issue field.
", "type": "Boolean!", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" @@ -5919,7 +5919,7 @@ "name": "OrganizationOrUser", "id": "organizationoruser", "href": "/graphql/reference/projects#union-organizationoruser", - "description": "Used for argument of CreateProjectV2 mutation.
", + "description": "An organization or user that can own resources.
", "isDeprecated": false, "possibleTypes": [ { diff --git a/src/graphql/data/fpt/schema-repos.json b/src/graphql/data/fpt/schema-repos.json index 1b592708e3f6..5f2bc28a6f08 100644 --- a/src/graphql/data/fpt/schema-repos.json +++ b/src/graphql/data/fpt/schema-repos.json @@ -4271,7 +4271,7 @@ }, { "name": "issueFields", - "description": "A list of the repository's issue fields, inherited from the organization.
", + "description": "A list of the repository's issue fields, inherited from the repository's owner.
", "type": "IssueFieldsConnection", "id": "issuefieldsconnection", "href": "/graphql/reference/issues#object-issuefieldsconnection", @@ -5094,6 +5094,61 @@ } ] }, + { + "name": "pinnedIssueFields", + "description": "An ordered list of the repository owner's issue fields pinned to issues when no type is selected.
", + "type": "IssueFieldsConnection", + "id": "issuefieldsconnection", + "href": "/graphql/reference/issues#object-issuefieldsconnection", + "arguments": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "first", + "description": "Returns the first n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "last", + "description": "Returns the last n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "orderBy", + "defaultValue": "{field: POSITION, direction: ASC}", + "description": "The order in which to return pinned issue fields.
", + "type": { + "name": "PinnedIssueFieldOrder", + "id": "pinnedissuefieldorder", + "href": "/graphql/reference/issues#input-object-pinnedissuefieldorder" + } + } + ] + }, { "name": "pinnedIssues", "description": "A list of pinned issues for this repository.
", diff --git a/src/graphql/data/fpt/schema-users.json b/src/graphql/data/fpt/schema-users.json index dde2a23b8a67..63ed359e3645 100644 --- a/src/graphql/data/fpt/schema-users.json +++ b/src/graphql/data/fpt/schema-users.json @@ -3976,6 +3976,116 @@ } ] }, + { + "name": "issueFields", + "description": "A list of the user's issue fields.
", + "type": "IssueFieldsConnection", + "id": "issuefieldsconnection", + "href": "/graphql/reference/issues#object-issuefieldsconnection", + "arguments": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "first", + "description": "Returns the first n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "last", + "description": "Returns the last n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "orderBy", + "defaultValue": "{field: CREATED_AT, direction: ASC}", + "description": "Ordering options for issue fields returned from the connection.
", + "type": { + "name": "IssueFieldOrder", + "id": "issuefieldorder", + "href": "/graphql/reference/issues#input-object-issuefieldorder" + } + } + ] + }, + { + "name": "issueTypes", + "description": "A list of the user's issue types.
", + "type": "IssueTypeConnection", + "id": "issuetypeconnection", + "href": "/graphql/reference/issues#object-issuetypeconnection", + "arguments": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "first", + "description": "Returns the first n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "last", + "description": "Returns the last n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "orderBy", + "defaultValue": "{field: CREATED_AT, direction: ASC}", + "description": "Ordering options for issue types returned from the connection.
", + "type": { + "name": "IssueTypeOrder", + "id": "issuetypeorder", + "href": "/graphql/reference/issues#input-object-issuetypeorder" + } + } + ] + }, { "name": "issues", "description": "A list of issues associated with this user.
", @@ -4418,6 +4528,61 @@ } ] }, + { + "name": "pinnedIssueFields", + "description": "An ordered list of issue fields pinned to issues when no type is selected.
", + "type": "IssueFieldsConnection", + "id": "issuefieldsconnection", + "href": "/graphql/reference/issues#object-issuefieldsconnection", + "arguments": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "first", + "description": "Returns the first n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "last", + "description": "Returns the last n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "orderBy", + "defaultValue": "{field: POSITION, direction: ASC}", + "description": "The order in which to return pinned issue fields.
", + "type": { + "name": "PinnedIssueFieldOrder", + "id": "pinnedissuefieldorder", + "href": "/graphql/reference/issues#input-object-pinnedissuefieldorder" + } + } + ] + }, { "name": "pinnedItems", "description": "A list of repositories and gists this profile owner has pinned to their profile.
", diff --git a/src/graphql/data/fpt/schema.docs.graphql b/src/graphql/data/fpt/schema.docs.graphql index c7bb99905f1b..16e6948f53e4 100644 --- a/src/graphql/data/fpt/schema.docs.graphql +++ b/src/graphql/data/fpt/schema.docs.graphql @@ -8829,9 +8829,9 @@ input CreateIssueFieldInput { options: [IssueFieldSingleSelectOptionInput!] """ - The ID of the organization where the issue field will be created. + The ID of the organization or user where the issue field will be created. """ - ownerId: ID! + ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "User"]) """ The visibility of the issue field. @@ -9008,7 +9008,7 @@ input CreateIssueTypeInput { description: String """ - Whether or not the issue type is enabled on the org level + Whether or not the issue type is enabled """ isEnabled: Boolean! @@ -9018,9 +9018,9 @@ input CreateIssueTypeInput { name: String! """ - The ID for the organization on which the issue type is created + The ID of the owner on which the issue type is created """ - ownerId: ID! + ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "User"]) } """ @@ -22862,14 +22862,19 @@ The visibility of an issue field. """ enum IssueFieldVisibility @docsCategory(name: "issues") { """ - All + Visible to everyone who can see the issue. """ ALL """ - Org Only + Visible to members of the owning organization and, where repository context is supplied, collaborators on that repository. + """ + ORG_ONLY @deprecated(reason: "`ORG_ONLY` will be removed. Use `RESTRICTED` instead. Removal on 2027-04-01 UTC.") + + """ + Visible to the owner and to collaborators on the repository the field is read through. """ - ORG_ONLY + RESTRICTED } """ @@ -38344,7 +38349,7 @@ enum OrganizationMigrationState @docsCategory(name: "migrations") { } """ -Used for argument of CreateProjectV2 mutation. +An organization or user that can own resources. """ union OrganizationOrUser @docsCategory(name: "projects") = Organization | User @@ -42081,12 +42086,12 @@ type ProjectV2Field implements Node & ProjectV2FieldCommon @docsCategory(name: " id: ID! """ - Returns true if this field is associated with an organization issue field + Returns true if this field is associated with an issue field """ isIssueField: Boolean! """ - The organization issue field associated with this project field, if any + The issue field associated with this project field, if any """ issueField: IssueFields @@ -42131,7 +42136,7 @@ interface ProjectV2FieldCommon @docsCategory(name: "projects") { id: ID! """ - Returns true if this field is associated with an organization issue field + Returns true if this field is associated with an issue field """ isIssueField: Boolean! @@ -43378,7 +43383,7 @@ type ProjectV2IterationField implements Node & ProjectV2FieldCommon @docsCategor id: ID! """ - Returns true if this field is associated with an organization issue field + Returns true if this field is associated with an issue field """ isIssueField: Boolean! @@ -43498,12 +43503,12 @@ type ProjectV2MultiSelectField implements Node & ProjectV2FieldCommon @docsCateg id: ID! """ - Returns true if this field is associated with an organization issue field + Returns true if this field is associated with an issue field """ isIssueField: Boolean! """ - The organization issue field associated with this project field, if any + The issue field associated with this project field, if any """ issueField: IssueFields @@ -43794,12 +43799,12 @@ type ProjectV2SingleSelectField implements Node & ProjectV2FieldCommon @docsCate id: ID! """ - Returns true if this field is associated with an organization issue field + Returns true if this field is associated with an issue field """ isIssueField: Boolean! """ - The organization issue field associated with this project field, if any + The issue field associated with this project field, if any """ issueField: IssueFields @@ -55838,7 +55843,7 @@ type Repository implements Node & issueCreationPolicy: IssueCreationPolicy """ - A list of the repository's issue fields, inherited from the organization + A list of the repository's issue fields, inherited from the repository's owner """ issueFields( """ @@ -56307,6 +56312,36 @@ type Repository implements Node & orderBy: PinnedEnvironmentOrder = {field: POSITION, direction: ASC} ): PinnedEnvironmentConnection + """ + An ordered list of the repository owner's issue fields pinned to issues when no type is selected. + """ + pinnedIssueFields( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + The order in which to return pinned issue fields. + """ + orderBy: PinnedIssueFieldOrder = {field: POSITION, direction: ASC} + ): IssueFieldsConnection + """ A list of pinned issues for this repository. """ @@ -71327,7 +71362,7 @@ input UpdateIssueTypeInput { description: String """ - Whether or not the issue type is enabled for the organization + Whether or not the issue type is enabled """ isEnabled: Boolean @@ -73585,6 +73620,66 @@ type User implements Actor & orderBy: IssueCommentOrder ): IssueCommentConnection! + """ + A list of the user's issue fields + """ + issueFields( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for issue fields returned from the connection. + """ + orderBy: IssueFieldOrder = {field: CREATED_AT, direction: ASC} + ): IssueFieldsConnection + + """ + A list of the user's issue types + """ + issueTypes( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for issue types returned from the connection. + """ + orderBy: IssueTypeOrder = {field: CREATED_AT, direction: ASC} + ): IssueTypeConnection + """ A list of issues associated with this user. """ @@ -73837,6 +73932,36 @@ type User implements Actor & types: [PinnableItemType!] ): PinnableItemConnection! + """ + An ordered list of issue fields pinned to issues when no type is selected. + """ + pinnedIssueFields( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + The order in which to return pinned issue fields. + """ + orderBy: PinnedIssueFieldOrder = {field: POSITION, direction: ASC} + ): IssueFieldsConnection + """ A list of repositories and gists this profile owner has pinned to their profile """ diff --git a/src/graphql/data/fpt/upcoming-changes.json b/src/graphql/data/fpt/upcoming-changes.json index eb97e2edeaa2..f361e6e874cf 100644 --- a/src/graphql/data/fpt/upcoming-changes.json +++ b/src/graphql/data/fpt/upcoming-changes.json @@ -7,6 +7,14 @@ "date": "2027-04-01", "criticality": "breaking", "owner": "corannejuang" + }, + { + "location": "IssueFieldVisibility.ORG_ONLY", + "description": "ORG_ONLY will be removed. Use RESTRICTED instead.
ORG_ONLY will be removed.
All.
" + "description": "Visible to everyone who can see the issue.
" }, { "name": "ORG_ONLY", - "description": "Org Only.
" + "description": "Visible to members of the owning organization and, where repository context is supplied, collaborators on that repository.
", + "isDeprecated": true, + "deprecationReason": "ORG_ONLY will be removed. Use RESTRICTED instead. Removal on 2027-04-01 UTC.
Visible to the owner and to collaborators on the repository the field is read through.
" } ], "category": "issues" @@ -11760,10 +11766,11 @@ }, { "name": "ownerId", - "description": "The ID of the organization where the issue field will be created.
", + "description": "The ID of the organization or user where the issue field will be created.
", "type": "ID!", "id": "id", - "href": "/graphql/reference/other#scalar-id" + "href": "/graphql/reference/other#scalar-id", + "isDeprecated": false }, { "name": "visibility", @@ -11949,7 +11956,7 @@ }, { "name": "isEnabled", - "description": "Whether or not the issue type is enabled on the org level.
", + "description": "Whether or not the issue type is enabled.
", "type": "Boolean!", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" @@ -11963,10 +11970,11 @@ }, { "name": "ownerId", - "description": "The ID for the organization on which the issue type is created.
", + "description": "The ID of the owner on which the issue type is created.
", "type": "ID!", "id": "id", - "href": "/graphql/reference/other#scalar-id" + "href": "/graphql/reference/other#scalar-id", + "isDeprecated": false } ], "category": "issues" @@ -13899,7 +13907,7 @@ }, { "name": "isEnabled", - "description": "Whether or not the issue type is enabled for the organization.
", + "description": "Whether or not the issue type is enabled.
", "type": "Boolean", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" diff --git a/src/graphql/data/ghec/schema-projects.json b/src/graphql/data/ghec/schema-projects.json index b05ab337f94b..4e761da3f4b9 100644 --- a/src/graphql/data/ghec/schema-projects.json +++ b/src/graphql/data/ghec/schema-projects.json @@ -2102,14 +2102,14 @@ }, { "name": "isIssueField", - "description": "Returns true if this field is associated with an organization issue field.
", + "description": "Returns true if this field is associated with an issue field.
", "type": "Boolean!", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" }, { "name": "issueField", - "description": "The organization issue field associated with this project field, if any.
", + "description": "The issue field associated with this project field, if any.
", "type": "IssueFields", "id": "issuefields", "href": "/graphql/reference/issues#union-issuefields" @@ -3535,7 +3535,7 @@ }, { "name": "isIssueField", - "description": "Returns true if this field is associated with an organization issue field.
", + "description": "Returns true if this field is associated with an issue field.
", "type": "Boolean!", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" @@ -3696,14 +3696,14 @@ }, { "name": "isIssueField", - "description": "Returns true if this field is associated with an organization issue field.
", + "description": "Returns true if this field is associated with an issue field.
", "type": "Boolean!", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" }, { "name": "issueField", - "description": "The organization issue field associated with this project field, if any.
", + "description": "The issue field associated with this project field, if any.
", "type": "IssueFields", "id": "issuefields", "href": "/graphql/reference/issues#union-issuefields" @@ -3851,14 +3851,14 @@ }, { "name": "isIssueField", - "description": "Returns true if this field is associated with an organization issue field.
", + "description": "Returns true if this field is associated with an issue field.
", "type": "Boolean!", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" }, { "name": "issueField", - "description": "The organization issue field associated with this project field, if any.
", + "description": "The issue field associated with this project field, if any.
", "type": "IssueFields", "id": "issuefields", "href": "/graphql/reference/issues#union-issuefields" @@ -5189,7 +5189,7 @@ }, { "name": "isIssueField", - "description": "Returns true if this field is associated with an organization issue field.
", + "description": "Returns true if this field is associated with an issue field.
", "type": "Boolean!", "id": "boolean", "href": "/graphql/reference/other#scalar-boolean" @@ -5919,7 +5919,7 @@ "name": "OrganizationOrUser", "id": "organizationoruser", "href": "/graphql/reference/projects#union-organizationoruser", - "description": "Used for argument of CreateProjectV2 mutation.
", + "description": "An organization or user that can own resources.
", "isDeprecated": false, "possibleTypes": [ { diff --git a/src/graphql/data/ghec/schema-repos.json b/src/graphql/data/ghec/schema-repos.json index 697ecf18bf90..dafa7d4b7b90 100644 --- a/src/graphql/data/ghec/schema-repos.json +++ b/src/graphql/data/ghec/schema-repos.json @@ -4271,7 +4271,7 @@ }, { "name": "issueFields", - "description": "A list of the repository's issue fields, inherited from the organization.
", + "description": "A list of the repository's issue fields, inherited from the repository's owner.
", "type": "IssueFieldsConnection", "id": "issuefieldsconnection", "href": "/graphql/reference/issues#object-issuefieldsconnection", @@ -5094,6 +5094,61 @@ } ] }, + { + "name": "pinnedIssueFields", + "description": "An ordered list of the repository owner's issue fields pinned to issues when no type is selected.
", + "type": "IssueFieldsConnection", + "id": "issuefieldsconnection", + "href": "/graphql/reference/issues#object-issuefieldsconnection", + "arguments": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "first", + "description": "Returns the first n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "last", + "description": "Returns the last n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "orderBy", + "defaultValue": "{field: POSITION, direction: ASC}", + "description": "The order in which to return pinned issue fields.
", + "type": { + "name": "PinnedIssueFieldOrder", + "id": "pinnedissuefieldorder", + "href": "/graphql/reference/issues#input-object-pinnedissuefieldorder" + } + } + ] + }, { "name": "pinnedIssues", "description": "A list of pinned issues for this repository.
", diff --git a/src/graphql/data/ghec/schema-users.json b/src/graphql/data/ghec/schema-users.json index dde2a23b8a67..63ed359e3645 100644 --- a/src/graphql/data/ghec/schema-users.json +++ b/src/graphql/data/ghec/schema-users.json @@ -3976,6 +3976,116 @@ } ] }, + { + "name": "issueFields", + "description": "A list of the user's issue fields.
", + "type": "IssueFieldsConnection", + "id": "issuefieldsconnection", + "href": "/graphql/reference/issues#object-issuefieldsconnection", + "arguments": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "first", + "description": "Returns the first n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "last", + "description": "Returns the last n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "orderBy", + "defaultValue": "{field: CREATED_AT, direction: ASC}", + "description": "Ordering options for issue fields returned from the connection.
", + "type": { + "name": "IssueFieldOrder", + "id": "issuefieldorder", + "href": "/graphql/reference/issues#input-object-issuefieldorder" + } + } + ] + }, + { + "name": "issueTypes", + "description": "A list of the user's issue types.
", + "type": "IssueTypeConnection", + "id": "issuetypeconnection", + "href": "/graphql/reference/issues#object-issuetypeconnection", + "arguments": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "first", + "description": "Returns the first n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "last", + "description": "Returns the last n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "orderBy", + "defaultValue": "{field: CREATED_AT, direction: ASC}", + "description": "Ordering options for issue types returned from the connection.
", + "type": { + "name": "IssueTypeOrder", + "id": "issuetypeorder", + "href": "/graphql/reference/issues#input-object-issuetypeorder" + } + } + ] + }, { "name": "issues", "description": "A list of issues associated with this user.
", @@ -4418,6 +4528,61 @@ } ] }, + { + "name": "pinnedIssueFields", + "description": "An ordered list of issue fields pinned to issues when no type is selected.
", + "type": "IssueFieldsConnection", + "id": "issuefieldsconnection", + "href": "/graphql/reference/issues#object-issuefieldsconnection", + "arguments": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + } + }, + { + "name": "first", + "description": "Returns the first n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "last", + "description": "Returns the last n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + } + }, + { + "name": "orderBy", + "defaultValue": "{field: POSITION, direction: ASC}", + "description": "The order in which to return pinned issue fields.
", + "type": { + "name": "PinnedIssueFieldOrder", + "id": "pinnedissuefieldorder", + "href": "/graphql/reference/issues#input-object-pinnedissuefieldorder" + } + } + ] + }, { "name": "pinnedItems", "description": "A list of repositories and gists this profile owner has pinned to their profile.
", diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index c7bb99905f1b..16e6948f53e4 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -8829,9 +8829,9 @@ input CreateIssueFieldInput { options: [IssueFieldSingleSelectOptionInput!] """ - The ID of the organization where the issue field will be created. + The ID of the organization or user where the issue field will be created. """ - ownerId: ID! + ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "User"]) """ The visibility of the issue field. @@ -9008,7 +9008,7 @@ input CreateIssueTypeInput { description: String """ - Whether or not the issue type is enabled on the org level + Whether or not the issue type is enabled """ isEnabled: Boolean! @@ -9018,9 +9018,9 @@ input CreateIssueTypeInput { name: String! """ - The ID for the organization on which the issue type is created + The ID of the owner on which the issue type is created """ - ownerId: ID! + ownerId: ID! @possibleTypes(concreteTypes: ["Organization", "User"]) } """ @@ -22862,14 +22862,19 @@ The visibility of an issue field. """ enum IssueFieldVisibility @docsCategory(name: "issues") { """ - All + Visible to everyone who can see the issue. """ ALL """ - Org Only + Visible to members of the owning organization and, where repository context is supplied, collaborators on that repository. + """ + ORG_ONLY @deprecated(reason: "`ORG_ONLY` will be removed. Use `RESTRICTED` instead. Removal on 2027-04-01 UTC.") + + """ + Visible to the owner and to collaborators on the repository the field is read through. """ - ORG_ONLY + RESTRICTED } """ @@ -38344,7 +38349,7 @@ enum OrganizationMigrationState @docsCategory(name: "migrations") { } """ -Used for argument of CreateProjectV2 mutation. +An organization or user that can own resources. """ union OrganizationOrUser @docsCategory(name: "projects") = Organization | User @@ -42081,12 +42086,12 @@ type ProjectV2Field implements Node & ProjectV2FieldCommon @docsCategory(name: " id: ID! """ - Returns true if this field is associated with an organization issue field + Returns true if this field is associated with an issue field """ isIssueField: Boolean! """ - The organization issue field associated with this project field, if any + The issue field associated with this project field, if any """ issueField: IssueFields @@ -42131,7 +42136,7 @@ interface ProjectV2FieldCommon @docsCategory(name: "projects") { id: ID! """ - Returns true if this field is associated with an organization issue field + Returns true if this field is associated with an issue field """ isIssueField: Boolean! @@ -43378,7 +43383,7 @@ type ProjectV2IterationField implements Node & ProjectV2FieldCommon @docsCategor id: ID! """ - Returns true if this field is associated with an organization issue field + Returns true if this field is associated with an issue field """ isIssueField: Boolean! @@ -43498,12 +43503,12 @@ type ProjectV2MultiSelectField implements Node & ProjectV2FieldCommon @docsCateg id: ID! """ - Returns true if this field is associated with an organization issue field + Returns true if this field is associated with an issue field """ isIssueField: Boolean! """ - The organization issue field associated with this project field, if any + The issue field associated with this project field, if any """ issueField: IssueFields @@ -43794,12 +43799,12 @@ type ProjectV2SingleSelectField implements Node & ProjectV2FieldCommon @docsCate id: ID! """ - Returns true if this field is associated with an organization issue field + Returns true if this field is associated with an issue field """ isIssueField: Boolean! """ - The organization issue field associated with this project field, if any + The issue field associated with this project field, if any """ issueField: IssueFields @@ -55838,7 +55843,7 @@ type Repository implements Node & issueCreationPolicy: IssueCreationPolicy """ - A list of the repository's issue fields, inherited from the organization + A list of the repository's issue fields, inherited from the repository's owner """ issueFields( """ @@ -56307,6 +56312,36 @@ type Repository implements Node & orderBy: PinnedEnvironmentOrder = {field: POSITION, direction: ASC} ): PinnedEnvironmentConnection + """ + An ordered list of the repository owner's issue fields pinned to issues when no type is selected. + """ + pinnedIssueFields( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + The order in which to return pinned issue fields. + """ + orderBy: PinnedIssueFieldOrder = {field: POSITION, direction: ASC} + ): IssueFieldsConnection + """ A list of pinned issues for this repository. """ @@ -71327,7 +71362,7 @@ input UpdateIssueTypeInput { description: String """ - Whether or not the issue type is enabled for the organization + Whether or not the issue type is enabled """ isEnabled: Boolean @@ -73585,6 +73620,66 @@ type User implements Actor & orderBy: IssueCommentOrder ): IssueCommentConnection! + """ + A list of the user's issue fields + """ + issueFields( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for issue fields returned from the connection. + """ + orderBy: IssueFieldOrder = {field: CREATED_AT, direction: ASC} + ): IssueFieldsConnection + + """ + A list of the user's issue types + """ + issueTypes( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for issue types returned from the connection. + """ + orderBy: IssueTypeOrder = {field: CREATED_AT, direction: ASC} + ): IssueTypeConnection + """ A list of issues associated with this user. """ @@ -73837,6 +73932,36 @@ type User implements Actor & types: [PinnableItemType!] ): PinnableItemConnection! + """ + An ordered list of issue fields pinned to issues when no type is selected. + """ + pinnedIssueFields( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + The order in which to return pinned issue fields. + """ + orderBy: PinnedIssueFieldOrder = {field: POSITION, direction: ASC} + ): IssueFieldsConnection + """ A list of repositories and gists this profile owner has pinned to their profile """ diff --git a/src/graphql/data/ghec/upcoming-changes.json b/src/graphql/data/ghec/upcoming-changes.json index eb97e2edeaa2..f361e6e874cf 100644 --- a/src/graphql/data/ghec/upcoming-changes.json +++ b/src/graphql/data/ghec/upcoming-changes.json @@ -7,6 +7,14 @@ "date": "2027-04-01", "criticality": "breaking", "owner": "corannejuang" + }, + { + "location": "IssueFieldVisibility.ORG_ONLY", + "description": "ORG_ONLY will be removed. Use RESTRICTED instead.
ORG_ONLY will be removed.
Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "title": "Code scanning AI Scan organization settings", @@ -48,6 +49,14 @@ "enabled", "disabled" ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the organization. The organization setting respects enterprise policy, and repositories inherit it: when disabled, repositories cannot enable the full repository AI Scan; when enabled, repositories can still opt out.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } }, "required": [ @@ -105,7 +114,16 @@ { "type": "string", "name": "pr_scan", - "description": "Whether AI Scan is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling AI Scan. Enabled organizations enable AI Scan for their repositories, but individual repositories can opt out.
", + "description": "Whether AI Scan on pull requests is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling AI Scan. Enabled organizations enable AI Scan for their repositories, but individual repositories can opt out.
", + "enum": [ + "enabled", + "disabled" + ] + }, + { + "type": "string", + "name": "repository_scan", + "description": "Whether the full repository AI Scan is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling the full repository AI Scan. Enabled organizations enable it for their repositories, but individual repositories can opt out.
", "enum": [ "enabled", "disabled" @@ -120,7 +138,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "parameters": { "org": "ORG" @@ -131,7 +150,8 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "title": "Code scanning AI Scan organization settings", @@ -145,6 +165,14 @@ "enabled", "disabled" ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the organization. The organization setting respects enterprise policy, and repositories inherit it: when disabled, repositories cannot enable the full repository AI Scan; when enabled, repositories can still opt out.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } }, "required": [ @@ -1682,14 +1710,23 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "description": "AI Scan enablement for a repository.", "type": "object", "properties": { "pr_scan": { - "description": "Whether AI Scan is enabled for the repository.", + "description": "Whether AI Scan on pull requests is enabled for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the repository.", "type": "string", "enum": [ "enabled", @@ -1761,7 +1798,16 @@ { "type": "string", "name": "pr_scan", - "description": "Whether to enable or disable AI Scan for the repository.
", + "description": "Whether to enable or disable AI Scan on pull requests for the repository.
", + "enum": [ + "enabled", + "disabled" + ] + }, + { + "type": "string", + "name": "repository_scan", + "description": "Whether to enable or disable the full repository AI Scan for the repository.
", "enum": [ "enabled", "disabled" @@ -1788,14 +1834,23 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "description": "AI Scan enablement for a repository.", "type": "object", "properties": { "pr_scan": { - "description": "Whether AI Scan is enabled for the repository.", + "description": "Whether AI Scan on pull requests is enabled for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the repository.", "type": "string", "enum": [ "enabled", @@ -2777,219 +2832,1123 @@ "url" ] } - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "403", - "description": "Response if GitHub Advanced Security is not enabled for this repository
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "503", - "description": "Service unavailable
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "title": "Get a code scanning alert", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Gets a single code scanning alert.
\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Response
", - "example": { - "number": 42, - "created_at": "2020-06-19T11:21:34Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", - "html_url": "https://github.com/octocat/hello-world/code-scanning/42", - "state": "dismissed", - "fixed_at": null, - "dismissed_by": { - "login": "octocat", - "id": 54933897, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_at": "2020-02-14T12:29:18Z", - "dismissed_reason": "false positive", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "security_severity_level": "high", - "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", - "name": "js/zipslip", - "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", - "help_uri": "https://codeql.github.com/" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "dismissed", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "spec-main/api-session-spec.ts", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [ - "test" - ] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" - }, - "schema": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { + }, + "linked_pull_requests": { + "description": "Pull requests linked to this alert.", + "type": "array", + "items": { + "title": "Pull Requests on Alerts", + "description": "A pull request linked to a code scanning alert.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The number of the linked pull request." + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the linked pull request." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "title": { + "type": "string", + "description": "The title of the linked pull request." + }, + "state": { + "type": "string", + "description": "The state of the referenced pull request.", + "enum": [ + "open", + "closed", + "merged" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time the linked pull request was merged. Null if it has not been merged." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the linked pull request on GitHub." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL for the linked pull request." + }, + "draft": { + "type": "boolean", + "description": "Whether the linked pull request is a draft." + } + }, + "required": [ + "number", + "id", + "repository", + "title", + "state", + "merged_at", + "html_url", + "url", + "draft" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { + "type": "string", + "description": "The title of the issue." + }, + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + }, + "required": [ + "number", + "title", + "state", + "url", + "html_url", + "repository", + "issue_type" + ] + } + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance" + ] + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "403", + "description": "Response if GitHub Advanced Security is not enabled for this repository
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Code scanning alerts\" repository permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + "title": "Get a code scanning alert", + "category": "code-scanning", + "subcategory": "code-scanning", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Gets a single code scanning alert.
\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Response
", + "example": { + "number": 42, + "created_at": "2020-06-19T11:21:34Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/octocat/hello-world/code-scanning/42", + "state": "dismissed", + "fixed_at": null, + "dismissed_by": { + "login": "octocat", + "id": 54933897, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "security_severity_level": "high", + "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", + "name": "js/zipslip", + "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "dismissed", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" + }, + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", "format": "uri", @@ -6504,30 +7463,303 @@ "self" ] }, - "author_association": { - "title": "author_association", + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "enabled_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "commit_title": { + "type": "string", + "description": "Title for the merge commit message." + }, + "commit_message": { + "type": "string", + "description": "Commit message for the merge commit." + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "stack": { + "title": "Pull Request Stack", + "description": "The stack information associated with a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The base ref of the stack this pull request belongs to." + }, + "sha": { + "type": "string", + "description": "The base SHA of the stack this pull request belongs to." + } + }, + "required": [ + "ref", + "sha" + ] + }, + "size": { + "type": "integer", + "description": "The total number of pull requests in the stack." + }, + "position": { + "type": "integer", + "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + }, + "id": { + "type": "integer", + "description": "The ID of the stack that this pull request belongs to." + }, + "number": { + "type": "integer", + "description": "The number of the stack that this pull request belongs to." + } + }, + "required": [ + "base" + ] + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + } + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merge_commit_sha", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "description": "The title of the issue." }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", "properties": { - "enabled_by": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -6638,114 +7870,314 @@ "url" ] }, - "merge_method": { + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] + "format": "uri", + "description": "The URL to view the repository on GitHub.com." }, - "commit_title": { + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { "type": "string", - "description": "Title for the merge commit message." + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." }, - "commit_message": { + "archive_url": { "type": "string", - "description": "Commit message for the merge commit." + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." } }, "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] }, - "stack": { - "title": "Pull Request Stack", - "description": "The stack information associated with a pull request.", + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" ], "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The base ref of the stack this pull request belongs to." - }, - "sha": { - "type": "string", - "description": "The base SHA of the stack this pull request belongs to." - } - }, - "required": [ - "ref", - "sha" - ] - }, - "size": { + "id": { "type": "integer", - "description": "The total number of pull requests in the stack." + "description": "The unique identifier of the issue type." }, - "position": { - "type": "integer", - "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." }, - "id": { - "type": "integer", - "description": "The ID of the stack that this pull request belongs to." + "name": { + "type": "string", + "description": "The name of the issue type." }, - "number": { - "type": "integer", - "description": "The number of the stack that this pull request belongs to." + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "base" + "id", + "node_id", + "name", + "description" ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" } }, "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", + "number", "title", - "updated_at", + "state", "url", - "user", - "author_association", - "auto_merge" + "html_url", + "repository", + "issue_type" ] } } @@ -10518,30 +11950,303 @@ "self" ] }, - "author_association": { - "title": "author_association", + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "enabled_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "commit_title": { + "type": "string", + "description": "Title for the merge commit message." + }, + "commit_message": { + "type": "string", + "description": "Commit message for the merge commit." + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "stack": { + "title": "Pull Request Stack", + "description": "The stack information associated with a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The base ref of the stack this pull request belongs to." + }, + "sha": { + "type": "string", + "description": "The base SHA of the stack this pull request belongs to." + } + }, + "required": [ + "ref", + "sha" + ] + }, + "size": { + "type": "integer", + "description": "The total number of pull requests in the stack." + }, + "position": { + "type": "integer", + "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + }, + "id": { + "type": "integer", + "description": "The ID of the stack that this pull request belongs to." + }, + "number": { + "type": "integer", + "description": "The number of the stack that this pull request belongs to." + } + }, + "required": [ + "base" + ] + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + } + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merge_commit_sha", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "description": "The title of the issue." }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", "properties": { - "enabled_by": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -10652,114 +12357,314 @@ "url" ] }, - "merge_method": { + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] + "format": "uri", + "description": "The URL to view the repository on GitHub.com." }, - "commit_title": { + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { "type": "string", - "description": "Title for the merge commit message." + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." }, - "commit_message": { + "archive_url": { "type": "string", - "description": "Commit message for the merge commit." + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." } }, "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] }, - "stack": { - "title": "Pull Request Stack", - "description": "The stack information associated with a pull request.", + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" ], "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The base ref of the stack this pull request belongs to." - }, - "sha": { - "type": "string", - "description": "The base SHA of the stack this pull request belongs to." - } - }, - "required": [ - "ref", - "sha" - ] - }, - "size": { + "id": { "type": "integer", - "description": "The total number of pull requests in the stack." + "description": "The unique identifier of the issue type." }, - "position": { - "type": "integer", - "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." }, - "id": { - "type": "integer", - "description": "The ID of the stack that this pull request belongs to." + "name": { + "type": "string", + "description": "The name of the issue type." }, - "number": { - "type": "integer", - "description": "The number of the stack that this pull request belongs to." + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "base" + "id", + "node_id", + "name", + "description" ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" } }, "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", "title", - "updated_at", + "state", "url", - "user", - "author_association", - "auto_merge" + "html_url", + "repository", + "issue_type" ] } } diff --git a/src/rest/data/fpt-2022-11-28/copilot.json b/src/rest/data/fpt-2022-11-28/copilot.json index e16cf3f56d6f..d2de17f24a2f 100644 --- a/src/rest/data/fpt-2022-11-28/copilot.json +++ b/src/rest/data/fpt-2022-11-28/copilot.json @@ -1665,10 +1665,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ] } }, { @@ -1759,10 +1763,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ] } }, { @@ -1853,10 +1861,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ] } }, { diff --git a/src/rest/data/fpt-2022-11-28/issues.json b/src/rest/data/fpt-2022-11-28/issues.json index 75ecf0f83dd2..44cdaf677bc0 100644 --- a/src/rest/data/fpt-2022-11-28/issues.json +++ b/src/rest/data/fpt-2022-11-28/issues.json @@ -6953,7 +6953,7 @@ }, { "name": "issue_field_values", - "description": "A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Supports both\nuser-owned and organization-owned repositories. Field availability depends\non the owner's issue field visibility settings and the caller's access.\nFor example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.
", + "description": "An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields must be enabled for the repository owner. Field values are silently dropped otherwise.
", "childParamsGroups": [ { "type": "integer", @@ -94663,7 +94663,7 @@ ] } ], - "descriptionHTML": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", + "descriptionHTML": "Add custom field values to an issue. You can set values for issue fields that have been defined for the repository's owner.\nAdding an empty array will clear all existing field values for the issue.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", "codeExamples": [ { "request": { @@ -94968,7 +94968,7 @@ ] } ], - "descriptionHTML": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.
Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", + "descriptionHTML": "Set custom field values for an issue, replacing any existing values. You can set values for issue fields that have been defined for the repository's owner.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.
Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", "codeExamples": [ { "request": { diff --git a/src/rest/data/fpt-2022-11-28/orgs.json b/src/rest/data/fpt-2022-11-28/orgs.json index 30797a16c935..62558f46cee8 100644 --- a/src/rest/data/fpt-2022-11-28/orgs.json +++ b/src/rest/data/fpt-2022-11-28/orgs.json @@ -10040,7 +10040,7 @@ "type": "array", "items": { "title": "Issue Field", - "description": "A custom attribute defined at the organization level for attaching structured data to issues.", + "description": "A custom attribute defined by a repository owner for attaching structured data to issues.", "type": [ "object", "null" @@ -10078,10 +10078,11 @@ }, "visibility": { "type": "string", - "description": "The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues).", + "description": "The visibility of the issue field. Organization-owned fields return `organization_members_only` for restricted visibility (visible to organization members and to collaborators on the repository the field is read through), or `all` (visible to all users who can see issues). For create and update requests, use `restricted` instead of the deprecated `organization_members_only` input. Existing REST API versions continue to return `organization_members_only` for restricted organization-owned fields, even when a request uses `restricted`. Any change to this response spelling will be introduced in a future REST API version.", "enum": [ "organization_members_only", - "all" + "all", + "restricted" ] }, "options": { @@ -10240,10 +10241,11 @@ { "type": "string", "name": "visibility", - "description": "The visibility of the issue field. Can be organization_members_only (visible only within the organization) or all (visible to all users who can see issues). Only used when the visibility settings feature is enabled. Defaults to organization_members_only.
The visibility of the issue field. Can be restricted (visible to organization members and to collaborators on the repository the field is read through) or all (visible to all users who can see issues). organization_members_only is deprecated. Use restricted instead. Removal will be announced for a future REST API version; existing REST API versions will continue to support this value. Only used when the visibility settings feature is enabled. Defaults to organization_members_only.
The visibility of the issue field. Can be organization_members_only (visible only within the organization) or all (visible to all users who can see issues). Only used when the visibility settings feature is enabled.
The visibility of the issue field. Can be restricted (visible to organization members and to collaborators on the repository the field is read through) or all (visible to all users who can see issues). organization_members_only is deprecated. Use restricted instead. Removal will be announced for a future REST API version; existing REST API versions will continue to support this value. Only used when the visibility settings feature is enabled.
Whether or not the issue type is enabled at the organization level.
", + "description": "Whether or not the issue type is enabled.
", "isRequired": true }, { @@ -11265,7 +11270,7 @@ { "type": "boolean", "name": "is_enabled", - "description": "Whether or not the issue type is enabled at the organization level.
", + "description": "Whether or not the issue type is enabled.
", "isRequired": true }, { @@ -16776,6 +16781,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -17506,6 +17512,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", diff --git a/src/rest/data/fpt-2022-11-28/repos.json b/src/rest/data/fpt-2022-11-28/repos.json index b5be6a41fa48..1e81232d7f56 100644 --- a/src/rest/data/fpt-2022-11-28/repos.json +++ b/src/rest/data/fpt-2022-11-28/repos.json @@ -1090,7 +1090,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Lists all issue fields for the authenticated user. OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.
Response
", + "example": [ + { + "id": 1, + "node_id": "IFT_kwDNAd3NAZo", + "name": "Text field", + "description": "DRI", + "data_type": "text", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 2, + "node_id": "IFSS_kwDNAd3NAZs", + "name": "Priority", + "description": "Level of importance", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "color": "red" + }, + { + "id": 2, + "name": "Medium", + "color": "yellow" + }, + { + "id": 3, + "name": "Low", + "color": "green" + } + ], + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 3, + "node_id": "IFMS_kwDNAd3NAZt", + "name": "Categories", + "description": "Issue categories", + "data_type": "multi_select", + "options": [ + { + "id": 4, + "name": "Frontend", + "color": "blue" + }, + { + "id": 5, + "name": "Backend", + "color": "green" + }, + { + "id": 6, + "name": "Infrastructure", + "color": "purple" + } + ], + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "User Issue Field", + "description": "A custom attribute defined by a personal account for attaching structured data to issues.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue field." + }, + "data_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + "visibility": { + "type": "string", + "description": "The visibility of the issue field. Can be `restricted` (visible only to the owner and to collaborators on the repository the field is read through) or `all` (visible to all users who can see issues).", + "enum": [ + "restricted", + "all" + ] + }, + "options": { + "description": "Available options for single select and multi select fields.", + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The name of the option." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the option." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the option.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "priority": { + "type": [ + "integer", + "null" + ], + "description": "The priority of the option for ordering." + }, + "created_at": { + "type": "string", + "description": "The time the option was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the option was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "name" + ] + } + }, + "created_at": { + "type": "string", + "description": "The time the issue field was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue field was updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "name", + "data_type" + ] + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/user/issue-fields", + "title": "Create an issue field", + "category": "users", + "subcategory": "issue-fields", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue field.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue field.
" + }, + { + "type": "string", + "name": "data_type", + "description": "The data type of the issue field.
", + "isRequired": true, + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + { + "type": "string", + "name": "visibility", + "description": "The visibility of the issue field. Can be restricted (visible only to the owner and to collaborators on the repository the field is read through) or all (visible to all users who can see issues). Defaults to restricted.
Options for select fields. Required when data_type is 'single_select' or 'multi_select'.
", + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "Name of the option.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the option.
" + }, + { + "type": "string", + "name": "color", + "description": "Color for the option.
", + "isRequired": true, + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ] + }, + { + "type": "integer", + "name": "priority", + "description": "Priority of the option for ordering.
", + "isRequired": true + } + ] + } + ], + "descriptionHTML": "Creates a new issue field for the authenticated user's personal account.
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Response
", + "example": { + "id": 512, + "node_id": "IF_kwDNAd3NAZr", + "name": "Priority", + "description": "Level of importance for the issue", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "description": "High priority", + "color": "red", + "priority": 1, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 2, + "name": "Medium", + "description": "Medium priority", + "color": "yellow", + "priority": 2, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 3, + "name": "Low", + "description": "Low priority", + "color": "green", + "priority": 3, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + } + ], + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + "schema": { + "title": "User Issue Field", + "description": "A custom attribute defined by a personal account for attaching structured data to issues.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue field." + }, + "data_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + "visibility": { + "type": "string", + "description": "The visibility of the issue field. Can be `restricted` (visible only to the owner and to collaborators on the repository the field is read through) or `all` (visible to all users who can see issues).", + "enum": [ + "restricted", + "all" + ] + }, + "options": { + "description": "Available options for single select and multi select fields.", + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The name of the option." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the option." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the option.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "priority": { + "type": [ + "integer", + "null" + ], + "description": "The priority of the option for ordering." + }, + "created_at": { + "type": "string", + "description": "The time the option was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the option was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "name" + ] + } + }, + "created_at": { + "type": "string", + "description": "The time the issue field was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue field was updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "name", + "data_type" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/user/issue-fields/{issue_field_id}", + "title": "Update an issue field", + "category": "users", + "subcategory": "issue-fields", + "parameters": [ + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue field.
" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue field.
" + }, + { + "type": "string", + "name": "visibility", + "description": "The visibility of the issue field. Can be restricted (visible only to the owner and to collaborators on the repository the field is read through) or all (visible to all users who can see issues).
Options for select fields. Only applicable when updating single_select or multi_select fields. When provided, this array replaces the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its id. Options sent without an id are treated as new options and may cause existing options to be deleted and recreated.
The id of an existing option to retain or update. Omit this when creating a new option.
" + }, + { + "type": "string", + "name": "name", + "description": "Name of the option.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the option.
" + }, + { + "type": "string", + "name": "color", + "description": "Color for the option.
", + "isRequired": true, + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ] + }, + { + "type": "integer", + "name": "priority", + "description": "Priority of the option for ordering.
", + "isRequired": true + } + ] + } + ], + "descriptionHTML": "Updates an issue field for the authenticated user.
\nThe authenticated user must own the issue field. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
Response
", + "example": { + "id": 512, + "node_id": "IF_kwDNAd3NAZr", + "name": "Priority", + "description": "Level of importance for the issue", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "description": "High priority", + "color": "red", + "priority": 1, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 2, + "name": "Medium", + "description": "Medium priority", + "color": "yellow", + "priority": 2, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 3, + "name": "Low", + "description": "Low priority", + "color": "green", + "priority": 3, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + } + ], + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + "schema": { + "title": "User Issue Field", + "description": "A custom attribute defined by a personal account for attaching structured data to issues.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue field." + }, + "data_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + "visibility": { + "type": "string", + "description": "The visibility of the issue field. Can be `restricted` (visible only to the owner and to collaborators on the repository the field is read through) or `all` (visible to all users who can see issues).", + "enum": [ + "restricted", + "all" + ] + }, + "options": { + "description": "Available options for single select and multi select fields.", + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The name of the option." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the option." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the option.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "priority": { + "type": [ + "integer", + "null" + ], + "description": "The priority of the option for ordering." + }, + "created_at": { + "type": "string", + "description": "The time the option was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the option was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "name" + ] + } + }, + "created_at": { + "type": "string", + "description": "The time the issue field was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue field was updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "name", + "data_type" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/user/issue-fields/{issue_field_id}", + "title": "Delete an issue field", + "category": "users", + "subcategory": "issue-fields", + "parameters": [ + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Deletes an issue field for the authenticated user.
\nThe authenticated user must own the issue field. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
A header with no content is returned.
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "A header with no content is returned.
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "write" + } + ] + } + } + ], + "issue-types": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/user/issue-types", + "title": "List issue types", + "category": "users", + "subcategory": "issue-types", + "parameters": [], + "bodyParameters": [], + "descriptionHTML": "Lists all issue types for the authenticated user. OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.
Response
", + "example": [ + { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 411, + "node_id": "IT_kwDNAd3NAZs", + "name": "Bug", + "description": "An unexpected problem or behavior", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/user/issue-types", + "title": "Create an issue type", + "category": "users", + "subcategory": "issue-types", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue type.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "Whether or not the issue type is enabled.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue type.
" + }, + { + "type": "string or null", + "name": "color", + "description": "Color for the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + } + ], + "descriptionHTML": "Creates a new issue type for the authenticated user's personal account.
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Response
", + "example": { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + "schema": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/user/issue-types/{issue_type_id}", + "title": "Update an issue type", + "category": "users", + "subcategory": "issue-types", + "parameters": [ + { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue type.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "Whether or not the issue type is enabled.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue type.
" + }, + { + "type": "string or null", + "name": "color", + "description": "Color for the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + } + ], + "descriptionHTML": "Updates an issue type for the authenticated user.
\nThe authenticated user must own the issue type. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
Response
", + "example": { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + "schema": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/user/issue-types/{issue_type_id}", + "title": "Delete an issue type", + "category": "users", + "subcategory": "issue-types", + "parameters": [ + { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Deletes an issue type for the authenticated user.
\nThe authenticated user must own the issue type. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "write" + } + ] + } + } + ], "keys": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/fpt-2026-03-10/code-scanning.json b/src/rest/data/fpt-2026-03-10/code-scanning.json index e4ba752ce888..a27deb8aebfb 100644 --- a/src/rest/data/fpt-2026-03-10/code-scanning.json +++ b/src/rest/data/fpt-2026-03-10/code-scanning.json @@ -34,7 +34,8 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "title": "Code scanning AI Scan organization settings", @@ -48,6 +49,14 @@ "enabled", "disabled" ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the organization. The organization setting respects enterprise policy, and repositories inherit it: when disabled, repositories cannot enable the full repository AI Scan; when enabled, repositories can still opt out.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } }, "required": [ @@ -105,7 +114,16 @@ { "type": "string", "name": "pr_scan", - "description": "Whether AI Scan is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling AI Scan. Enabled organizations enable AI Scan for their repositories, but individual repositories can opt out.
", + "description": "Whether AI Scan on pull requests is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling AI Scan. Enabled organizations enable AI Scan for their repositories, but individual repositories can opt out.
", + "enum": [ + "enabled", + "disabled" + ] + }, + { + "type": "string", + "name": "repository_scan", + "description": "Whether the full repository AI Scan is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling the full repository AI Scan. Enabled organizations enable it for their repositories, but individual repositories can opt out.
", "enum": [ "enabled", "disabled" @@ -120,7 +138,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "parameters": { "org": "ORG" @@ -131,7 +150,8 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "title": "Code scanning AI Scan organization settings", @@ -145,6 +165,14 @@ "enabled", "disabled" ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the organization. The organization setting respects enterprise policy, and repositories inherit it: when disabled, repositories cannot enable the full repository AI Scan; when enabled, repositories can still opt out.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } }, "required": [ @@ -1682,14 +1710,23 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "description": "AI Scan enablement for a repository.", "type": "object", "properties": { "pr_scan": { - "description": "Whether AI Scan is enabled for the repository.", + "description": "Whether AI Scan on pull requests is enabled for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the repository.", "type": "string", "enum": [ "enabled", @@ -1761,7 +1798,16 @@ { "type": "string", "name": "pr_scan", - "description": "Whether to enable or disable AI Scan for the repository.
", + "description": "Whether to enable or disable AI Scan on pull requests for the repository.
", + "enum": [ + "enabled", + "disabled" + ] + }, + { + "type": "string", + "name": "repository_scan", + "description": "Whether to enable or disable the full repository AI Scan for the repository.
", "enum": [ "enabled", "disabled" @@ -1788,14 +1834,23 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "description": "AI Scan enablement for a repository.", "type": "object", "properties": { "pr_scan": { - "description": "Whether AI Scan is enabled for the repository.", + "description": "Whether AI Scan on pull requests is enabled for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the repository.", "type": "string", "enum": [ "enabled", @@ -2777,219 +2832,1123 @@ "url" ] } - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "403", - "description": "Response if GitHub Advanced Security is not enabled for this repository
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "503", - "description": "Service unavailable
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "title": "Get a code scanning alert", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Gets a single code scanning alert.
\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Response
", - "example": { - "number": 42, - "created_at": "2020-06-19T11:21:34Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", - "html_url": "https://github.com/octocat/hello-world/code-scanning/42", - "state": "dismissed", - "fixed_at": null, - "dismissed_by": { - "login": "octocat", - "id": 54933897, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_at": "2020-02-14T12:29:18Z", - "dismissed_reason": "false positive", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "security_severity_level": "high", - "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", - "name": "js/zipslip", - "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", - "help_uri": "https://codeql.github.com/" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "dismissed", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "spec-main/api-session-spec.ts", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [ - "test" - ] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" - }, - "schema": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { + }, + "linked_pull_requests": { + "description": "Pull requests linked to this alert.", + "type": "array", + "items": { + "title": "Pull Requests on Alerts", + "description": "A pull request linked to a code scanning alert.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The number of the linked pull request." + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the linked pull request." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "title": { + "type": "string", + "description": "The title of the linked pull request." + }, + "state": { + "type": "string", + "description": "The state of the referenced pull request.", + "enum": [ + "open", + "closed", + "merged" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time the linked pull request was merged. Null if it has not been merged." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the linked pull request on GitHub." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL for the linked pull request." + }, + "draft": { + "type": "boolean", + "description": "Whether the linked pull request is a draft." + } + }, + "required": [ + "number", + "id", + "repository", + "title", + "state", + "merged_at", + "html_url", + "url", + "draft" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { + "type": "string", + "description": "The title of the issue." + }, + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + }, + "required": [ + "number", + "title", + "state", + "url", + "html_url", + "repository", + "issue_type" + ] + } + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance" + ] + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "403", + "description": "Response if GitHub Advanced Security is not enabled for this repository
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Code scanning alerts\" repository permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + "title": "Get a code scanning alert", + "category": "code-scanning", + "subcategory": "code-scanning", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Gets a single code scanning alert.
\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Response
", + "example": { + "number": 42, + "created_at": "2020-06-19T11:21:34Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/octocat/hello-world/code-scanning/42", + "state": "dismissed", + "fixed_at": null, + "dismissed_by": { + "login": "octocat", + "id": 54933897, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "security_severity_level": "high", + "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", + "name": "js/zipslip", + "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "dismissed", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" + }, + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", "format": "uri", @@ -6348,30 +7307,301 @@ "self" ] }, - "author_association": { - "title": "author_association", + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "enabled_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "commit_title": { + "type": "string", + "description": "Title for the merge commit message." + }, + "commit_message": { + "type": "string", + "description": "Commit message for the merge commit." + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "stack": { + "title": "Pull Request Stack", + "description": "The stack information associated with a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The base ref of the stack this pull request belongs to." + }, + "sha": { + "type": "string", + "description": "The base SHA of the stack this pull request belongs to." + } + }, + "required": [ + "ref", + "sha" + ] + }, + "size": { + "type": "integer", + "description": "The total number of pull requests in the stack." + }, + "position": { + "type": "integer", + "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + }, + "id": { + "type": "integer", + "description": "The ID of the stack that this pull request belongs to." + }, + "number": { + "type": "integer", + "description": "The number of the stack that this pull request belongs to." + } + }, + "required": [ + "base" + ] + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + } + }, + "required": [ + "_links", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "description": "The title of the issue." }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", "properties": { - "enabled_by": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -6482,112 +7712,314 @@ "url" ] }, - "merge_method": { + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] + "format": "uri", + "description": "The URL to view the repository on GitHub.com." }, - "commit_title": { + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { "type": "string", - "description": "Title for the merge commit message." + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." }, - "commit_message": { + "archive_url": { "type": "string", - "description": "Commit message for the merge commit." + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." } }, "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] }, - "stack": { - "title": "Pull Request Stack", - "description": "The stack information associated with a pull request.", + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" ], "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The base ref of the stack this pull request belongs to." - }, - "sha": { - "type": "string", - "description": "The base SHA of the stack this pull request belongs to." - } - }, - "required": [ - "ref", - "sha" - ] - }, - "size": { + "id": { "type": "integer", - "description": "The total number of pull requests in the stack." + "description": "The unique identifier of the issue type." }, - "position": { - "type": "integer", - "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." }, - "id": { - "type": "integer", - "description": "The ID of the stack that this pull request belongs to." + "name": { + "type": "string", + "description": "The name of the issue type." }, - "number": { - "type": "integer", - "description": "The number of the stack that this pull request belongs to." + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "base" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - } - }, - "required": [ - "_links", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", + "id", + "node_id", + "name", + "description" + ] + } + }, + "required": [ + "number", "title", - "updated_at", + "state", "url", - "user", - "author_association", - "auto_merge" + "html_url", + "repository", + "issue_type" ] } } @@ -10204,30 +11636,301 @@ "self" ] }, - "author_association": { - "title": "author_association", + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "enabled_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "commit_title": { + "type": "string", + "description": "Title for the merge commit message." + }, + "commit_message": { + "type": "string", + "description": "Commit message for the merge commit." + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "stack": { + "title": "Pull Request Stack", + "description": "The stack information associated with a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The base ref of the stack this pull request belongs to." + }, + "sha": { + "type": "string", + "description": "The base SHA of the stack this pull request belongs to." + } + }, + "required": [ + "ref", + "sha" + ] + }, + "size": { + "type": "integer", + "description": "The total number of pull requests in the stack." + }, + "position": { + "type": "integer", + "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + }, + "id": { + "type": "integer", + "description": "The ID of the stack that this pull request belongs to." + }, + "number": { + "type": "integer", + "description": "The number of the stack that this pull request belongs to." + } + }, + "required": [ + "base" + ] + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + } + }, + "required": [ + "_links", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "description": "The title of the issue." }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", "properties": { - "enabled_by": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -10338,112 +12041,314 @@ "url" ] }, - "merge_method": { + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] + "format": "uri", + "description": "The URL to view the repository on GitHub.com." }, - "commit_title": { + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { "type": "string", - "description": "Title for the merge commit message." + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." }, - "commit_message": { + "archive_url": { "type": "string", - "description": "Commit message for the merge commit." + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." } }, "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] }, - "stack": { - "title": "Pull Request Stack", - "description": "The stack information associated with a pull request.", + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" ], "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The base ref of the stack this pull request belongs to." - }, - "sha": { - "type": "string", - "description": "The base SHA of the stack this pull request belongs to." - } - }, - "required": [ - "ref", - "sha" - ] - }, - "size": { + "id": { "type": "integer", - "description": "The total number of pull requests in the stack." + "description": "The unique identifier of the issue type." }, - "position": { - "type": "integer", - "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." }, - "id": { - "type": "integer", - "description": "The ID of the stack that this pull request belongs to." + "name": { + "type": "string", + "description": "The name of the issue type." }, - "number": { - "type": "integer", - "description": "The number of the stack that this pull request belongs to." + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "base" + "id", + "node_id", + "name", + "description" ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" } }, "required": [ - "_links", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merged_at", - "milestone", "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", "title", - "updated_at", + "state", "url", - "user", - "author_association", - "auto_merge" + "html_url", + "repository", + "issue_type" ] } } diff --git a/src/rest/data/fpt-2026-03-10/copilot.json b/src/rest/data/fpt-2026-03-10/copilot.json index a6c3b6a3be53..d0b7e8b6d513 100644 --- a/src/rest/data/fpt-2026-03-10/copilot.json +++ b/src/rest/data/fpt-2026-03-10/copilot.json @@ -1665,10 +1665,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ] } }, { @@ -1759,10 +1763,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ] } }, { @@ -1853,10 +1861,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ] } }, { diff --git a/src/rest/data/fpt-2026-03-10/issues.json b/src/rest/data/fpt-2026-03-10/issues.json index b87777618653..87d9c8db0eb1 100644 --- a/src/rest/data/fpt-2026-03-10/issues.json +++ b/src/rest/data/fpt-2026-03-10/issues.json @@ -6693,7 +6693,7 @@ }, { "name": "issue_field_values", - "description": "A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Supports both\nuser-owned and organization-owned repositories. Field availability depends\non the owner's issue field visibility settings and the caller's access.\nFor example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.
", + "description": "An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields must be enabled for the repository owner. Field values are silently dropped otherwise.
", "childParamsGroups": [ { "type": "integer", @@ -91983,7 +91983,7 @@ ] } ], - "descriptionHTML": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", + "descriptionHTML": "Add custom field values to an issue. You can set values for issue fields that have been defined for the repository's owner.\nAdding an empty array will clear all existing field values for the issue.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", "codeExamples": [ { "request": { @@ -92288,7 +92288,7 @@ ] } ], - "descriptionHTML": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.
Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", + "descriptionHTML": "Set custom field values for an issue, replacing any existing values. You can set values for issue fields that have been defined for the repository's owner.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.
Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", "codeExamples": [ { "request": { diff --git a/src/rest/data/fpt-2026-03-10/orgs.json b/src/rest/data/fpt-2026-03-10/orgs.json index 8a89934fe7ab..df413c96418e 100644 --- a/src/rest/data/fpt-2026-03-10/orgs.json +++ b/src/rest/data/fpt-2026-03-10/orgs.json @@ -9985,7 +9985,7 @@ "type": "array", "items": { "title": "Issue Field", - "description": "A custom attribute defined at the organization level for attaching structured data to issues.", + "description": "A custom attribute defined by a repository owner for attaching structured data to issues.", "type": [ "object", "null" @@ -10023,10 +10023,11 @@ }, "visibility": { "type": "string", - "description": "The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues).", + "description": "The visibility of the issue field. Organization-owned fields return `organization_members_only` for restricted visibility (visible to organization members and to collaborators on the repository the field is read through), or `all` (visible to all users who can see issues). For create and update requests, use `restricted` instead of the deprecated `organization_members_only` input. Existing REST API versions continue to return `organization_members_only` for restricted organization-owned fields, even when a request uses `restricted`. Any change to this response spelling will be introduced in a future REST API version.", "enum": [ "organization_members_only", - "all" + "all", + "restricted" ] }, "options": { @@ -10185,10 +10186,11 @@ { "type": "string", "name": "visibility", - "description": "The visibility of the issue field. Can be organization_members_only (visible only within the organization) or all (visible to all users who can see issues). Only used when the visibility settings feature is enabled. Defaults to organization_members_only.
The visibility of the issue field. Can be restricted (visible to organization members and to collaborators on the repository the field is read through) or all (visible to all users who can see issues). organization_members_only is deprecated. Use restricted instead. Removal will be announced for a future REST API version; existing REST API versions will continue to support this value. Only used when the visibility settings feature is enabled. Defaults to organization_members_only.
The visibility of the issue field. Can be organization_members_only (visible only within the organization) or all (visible to all users who can see issues). Only used when the visibility settings feature is enabled.
The visibility of the issue field. Can be restricted (visible to organization members and to collaborators on the repository the field is read through) or all (visible to all users who can see issues). organization_members_only is deprecated. Use restricted instead. Removal will be announced for a future REST API version; existing REST API versions will continue to support this value. Only used when the visibility settings feature is enabled.
Whether or not the issue type is enabled at the organization level.
", + "description": "Whether or not the issue type is enabled.
", "isRequired": true }, { @@ -11210,7 +11215,7 @@ { "type": "boolean", "name": "is_enabled", - "description": "Whether or not the issue type is enabled at the organization level.
", + "description": "Whether or not the issue type is enabled.
", "isRequired": true }, { @@ -16729,6 +16734,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -17459,6 +17465,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", diff --git a/src/rest/data/fpt-2026-03-10/repos.json b/src/rest/data/fpt-2026-03-10/repos.json index 9453868cabef..d22bd394613b 100644 --- a/src/rest/data/fpt-2026-03-10/repos.json +++ b/src/rest/data/fpt-2026-03-10/repos.json @@ -1087,7 +1087,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Lists all issue fields for the authenticated user. OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.
Response
", + "example": [ + { + "id": 1, + "node_id": "IFT_kwDNAd3NAZo", + "name": "Text field", + "description": "DRI", + "data_type": "text", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 2, + "node_id": "IFSS_kwDNAd3NAZs", + "name": "Priority", + "description": "Level of importance", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "color": "red" + }, + { + "id": 2, + "name": "Medium", + "color": "yellow" + }, + { + "id": 3, + "name": "Low", + "color": "green" + } + ], + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 3, + "node_id": "IFMS_kwDNAd3NAZt", + "name": "Categories", + "description": "Issue categories", + "data_type": "multi_select", + "options": [ + { + "id": 4, + "name": "Frontend", + "color": "blue" + }, + { + "id": 5, + "name": "Backend", + "color": "green" + }, + { + "id": 6, + "name": "Infrastructure", + "color": "purple" + } + ], + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "User Issue Field", + "description": "A custom attribute defined by a personal account for attaching structured data to issues.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue field." + }, + "data_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + "visibility": { + "type": "string", + "description": "The visibility of the issue field. Can be `restricted` (visible only to the owner and to collaborators on the repository the field is read through) or `all` (visible to all users who can see issues).", + "enum": [ + "restricted", + "all" + ] + }, + "options": { + "description": "Available options for single select and multi select fields.", + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The name of the option." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the option." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the option.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "priority": { + "type": [ + "integer", + "null" + ], + "description": "The priority of the option for ordering." + }, + "created_at": { + "type": "string", + "description": "The time the option was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the option was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "name" + ] + } + }, + "created_at": { + "type": "string", + "description": "The time the issue field was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue field was updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "name", + "data_type" + ] + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/user/issue-fields", + "title": "Create an issue field", + "category": "users", + "subcategory": "issue-fields", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue field.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue field.
" + }, + { + "type": "string", + "name": "data_type", + "description": "The data type of the issue field.
", + "isRequired": true, + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + { + "type": "string", + "name": "visibility", + "description": "The visibility of the issue field. Can be restricted (visible only to the owner and to collaborators on the repository the field is read through) or all (visible to all users who can see issues). Defaults to restricted.
Options for select fields. Required when data_type is 'single_select' or 'multi_select'.
", + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "Name of the option.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the option.
" + }, + { + "type": "string", + "name": "color", + "description": "Color for the option.
", + "isRequired": true, + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ] + }, + { + "type": "integer", + "name": "priority", + "description": "Priority of the option for ordering.
", + "isRequired": true + } + ] + } + ], + "descriptionHTML": "Creates a new issue field for the authenticated user's personal account.
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Response
", + "example": { + "id": 512, + "node_id": "IF_kwDNAd3NAZr", + "name": "Priority", + "description": "Level of importance for the issue", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "description": "High priority", + "color": "red", + "priority": 1, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 2, + "name": "Medium", + "description": "Medium priority", + "color": "yellow", + "priority": 2, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 3, + "name": "Low", + "description": "Low priority", + "color": "green", + "priority": 3, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + } + ], + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + "schema": { + "title": "User Issue Field", + "description": "A custom attribute defined by a personal account for attaching structured data to issues.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue field." + }, + "data_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + "visibility": { + "type": "string", + "description": "The visibility of the issue field. Can be `restricted` (visible only to the owner and to collaborators on the repository the field is read through) or `all` (visible to all users who can see issues).", + "enum": [ + "restricted", + "all" + ] + }, + "options": { + "description": "Available options for single select and multi select fields.", + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The name of the option." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the option." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the option.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "priority": { + "type": [ + "integer", + "null" + ], + "description": "The priority of the option for ordering." + }, + "created_at": { + "type": "string", + "description": "The time the option was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the option was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "name" + ] + } + }, + "created_at": { + "type": "string", + "description": "The time the issue field was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue field was updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "name", + "data_type" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/user/issue-fields/{issue_field_id}", + "title": "Update an issue field", + "category": "users", + "subcategory": "issue-fields", + "parameters": [ + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue field.
" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue field.
" + }, + { + "type": "string", + "name": "visibility", + "description": "The visibility of the issue field. Can be restricted (visible only to the owner and to collaborators on the repository the field is read through) or all (visible to all users who can see issues).
Options for select fields. Only applicable when updating single_select or multi_select fields. When provided, this array replaces the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its id. Options sent without an id are treated as new options and may cause existing options to be deleted and recreated.
The id of an existing option to retain or update. Omit this when creating a new option.
" + }, + { + "type": "string", + "name": "name", + "description": "Name of the option.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the option.
" + }, + { + "type": "string", + "name": "color", + "description": "Color for the option.
", + "isRequired": true, + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ] + }, + { + "type": "integer", + "name": "priority", + "description": "Priority of the option for ordering.
", + "isRequired": true + } + ] + } + ], + "descriptionHTML": "Updates an issue field for the authenticated user.
\nThe authenticated user must own the issue field. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
Response
", + "example": { + "id": 512, + "node_id": "IF_kwDNAd3NAZr", + "name": "Priority", + "description": "Level of importance for the issue", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "description": "High priority", + "color": "red", + "priority": 1, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 2, + "name": "Medium", + "description": "Medium priority", + "color": "yellow", + "priority": 2, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 3, + "name": "Low", + "description": "Low priority", + "color": "green", + "priority": 3, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + } + ], + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + "schema": { + "title": "User Issue Field", + "description": "A custom attribute defined by a personal account for attaching structured data to issues.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue field." + }, + "data_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + "visibility": { + "type": "string", + "description": "The visibility of the issue field. Can be `restricted` (visible only to the owner and to collaborators on the repository the field is read through) or `all` (visible to all users who can see issues).", + "enum": [ + "restricted", + "all" + ] + }, + "options": { + "description": "Available options for single select and multi select fields.", + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The name of the option." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the option." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the option.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "priority": { + "type": [ + "integer", + "null" + ], + "description": "The priority of the option for ordering." + }, + "created_at": { + "type": "string", + "description": "The time the option was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the option was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "name" + ] + } + }, + "created_at": { + "type": "string", + "description": "The time the issue field was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue field was updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "name", + "data_type" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/user/issue-fields/{issue_field_id}", + "title": "Delete an issue field", + "category": "users", + "subcategory": "issue-fields", + "parameters": [ + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Deletes an issue field for the authenticated user.
\nThe authenticated user must own the issue field. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
A header with no content is returned.
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "A header with no content is returned.
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "write" + } + ] + } + } + ], + "issue-types": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/user/issue-types", + "title": "List issue types", + "category": "users", + "subcategory": "issue-types", + "parameters": [], + "bodyParameters": [], + "descriptionHTML": "Lists all issue types for the authenticated user. OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.
Response
", + "example": [ + { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 411, + "node_id": "IT_kwDNAd3NAZs", + "name": "Bug", + "description": "An unexpected problem or behavior", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/user/issue-types", + "title": "Create an issue type", + "category": "users", + "subcategory": "issue-types", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue type.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "Whether or not the issue type is enabled.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue type.
" + }, + { + "type": "string or null", + "name": "color", + "description": "Color for the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + } + ], + "descriptionHTML": "Creates a new issue type for the authenticated user's personal account.
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Response
", + "example": { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + "schema": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/user/issue-types/{issue_type_id}", + "title": "Update an issue type", + "category": "users", + "subcategory": "issue-types", + "parameters": [ + { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue type.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "Whether or not the issue type is enabled.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue type.
" + }, + { + "type": "string or null", + "name": "color", + "description": "Color for the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + } + ], + "descriptionHTML": "Updates an issue type for the authenticated user.
\nThe authenticated user must own the issue type. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
Response
", + "example": { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + "schema": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/user/issue-types/{issue_type_id}", + "title": "Delete an issue type", + "category": "users", + "subcategory": "issue-types", + "parameters": [ + { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Deletes an issue type for the authenticated user.
\nThe authenticated user must own the issue type. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "write" + } + ] + } + } + ], "keys": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghec-2022-11-28/code-scanning.json b/src/rest/data/ghec-2022-11-28/code-scanning.json index 8f35f9a3d969..08975bc25119 100644 --- a/src/rest/data/ghec-2022-11-28/code-scanning.json +++ b/src/rest/data/ghec-2022-11-28/code-scanning.json @@ -1466,7 +1466,8 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "title": "Code scanning AI Scan organization settings", @@ -1480,6 +1481,14 @@ "enabled", "disabled" ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the organization. The organization setting respects enterprise policy, and repositories inherit it: when disabled, repositories cannot enable the full repository AI Scan; when enabled, repositories can still opt out.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } }, "required": [ @@ -1537,7 +1546,16 @@ { "type": "string", "name": "pr_scan", - "description": "Whether AI Scan is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling AI Scan. Enabled organizations enable AI Scan for their repositories, but individual repositories can opt out.
", + "description": "Whether AI Scan on pull requests is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling AI Scan. Enabled organizations enable AI Scan for their repositories, but individual repositories can opt out.
", + "enum": [ + "enabled", + "disabled" + ] + }, + { + "type": "string", + "name": "repository_scan", + "description": "Whether the full repository AI Scan is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling the full repository AI Scan. Enabled organizations enable it for their repositories, but individual repositories can opt out.
", "enum": [ "enabled", "disabled" @@ -1552,7 +1570,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "parameters": { "org": "ORG" @@ -1563,7 +1582,8 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "title": "Code scanning AI Scan organization settings", @@ -1577,6 +1597,14 @@ "enabled", "disabled" ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the organization. The organization setting respects enterprise policy, and repositories inherit it: when disabled, repositories cannot enable the full repository AI Scan; when enabled, repositories can still opt out.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } }, "required": [ @@ -3114,14 +3142,23 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "description": "AI Scan enablement for a repository.", "type": "object", "properties": { "pr_scan": { - "description": "Whether AI Scan is enabled for the repository.", + "description": "Whether AI Scan on pull requests is enabled for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the repository.", "type": "string", "enum": [ "enabled", @@ -3193,7 +3230,16 @@ { "type": "string", "name": "pr_scan", - "description": "Whether to enable or disable AI Scan for the repository.
", + "description": "Whether to enable or disable AI Scan on pull requests for the repository.
", + "enum": [ + "enabled", + "disabled" + ] + }, + { + "type": "string", + "name": "repository_scan", + "description": "Whether to enable or disable the full repository AI Scan for the repository.
", "enum": [ "enabled", "disabled" @@ -3220,14 +3266,23 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "description": "AI Scan enablement for a repository.", "type": "object", "properties": { "pr_scan": { - "description": "Whether AI Scan is enabled for the repository.", + "description": "Whether AI Scan on pull requests is enabled for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the repository.", "type": "string", "enum": [ "enabled", @@ -4209,219 +4264,1123 @@ "url" ] } - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "403", - "description": "Response if GitHub Advanced Security is not enabled for this repository
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "503", - "description": "Service unavailable
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "title": "Get a code scanning alert", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Gets a single code scanning alert.
\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Response
", - "example": { - "number": 42, - "created_at": "2020-06-19T11:21:34Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", - "html_url": "https://github.com/octocat/hello-world/code-scanning/42", - "state": "dismissed", - "fixed_at": null, - "dismissed_by": { - "login": "octocat", - "id": 54933897, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_at": "2020-02-14T12:29:18Z", - "dismissed_reason": "false positive", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "security_severity_level": "high", - "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", - "name": "js/zipslip", - "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", - "help_uri": "https://codeql.github.com/" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "dismissed", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "spec-main/api-session-spec.ts", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [ - "test" - ] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" - }, - "schema": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { + }, + "linked_pull_requests": { + "description": "Pull requests linked to this alert.", + "type": "array", + "items": { + "title": "Pull Requests on Alerts", + "description": "A pull request linked to a code scanning alert.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The number of the linked pull request." + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the linked pull request." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "title": { + "type": "string", + "description": "The title of the linked pull request." + }, + "state": { + "type": "string", + "description": "The state of the referenced pull request.", + "enum": [ + "open", + "closed", + "merged" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time the linked pull request was merged. Null if it has not been merged." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the linked pull request on GitHub." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL for the linked pull request." + }, + "draft": { + "type": "boolean", + "description": "Whether the linked pull request is a draft." + } + }, + "required": [ + "number", + "id", + "repository", + "title", + "state", + "merged_at", + "html_url", + "url", + "draft" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { + "type": "string", + "description": "The title of the issue." + }, + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + }, + "required": [ + "number", + "title", + "state", + "url", + "html_url", + "repository", + "issue_type" + ] + } + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance" + ] + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "403", + "description": "Response if GitHub Advanced Security is not enabled for this repository
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Code scanning alerts\" repository permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + "title": "Get a code scanning alert", + "category": "code-scanning", + "subcategory": "code-scanning", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Gets a single code scanning alert.
\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Response
", + "example": { + "number": 42, + "created_at": "2020-06-19T11:21:34Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/octocat/hello-world/code-scanning/42", + "state": "dismissed", + "fixed_at": null, + "dismissed_by": { + "login": "octocat", + "id": 54933897, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "security_severity_level": "high", + "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", + "name": "js/zipslip", + "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "dismissed", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" + }, + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", "format": "uri", @@ -7936,30 +8895,303 @@ "self" ] }, - "author_association": { - "title": "author_association", + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "enabled_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "commit_title": { + "type": "string", + "description": "Title for the merge commit message." + }, + "commit_message": { + "type": "string", + "description": "Commit message for the merge commit." + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "stack": { + "title": "Pull Request Stack", + "description": "The stack information associated with a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The base ref of the stack this pull request belongs to." + }, + "sha": { + "type": "string", + "description": "The base SHA of the stack this pull request belongs to." + } + }, + "required": [ + "ref", + "sha" + ] + }, + "size": { + "type": "integer", + "description": "The total number of pull requests in the stack." + }, + "position": { + "type": "integer", + "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + }, + "id": { + "type": "integer", + "description": "The ID of the stack that this pull request belongs to." + }, + "number": { + "type": "integer", + "description": "The number of the stack that this pull request belongs to." + } + }, + "required": [ + "base" + ] + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + } + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merge_commit_sha", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "description": "The title of the issue." }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", "properties": { - "enabled_by": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -8070,114 +9302,314 @@ "url" ] }, - "merge_method": { + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] + "format": "uri", + "description": "The URL to view the repository on GitHub.com." }, - "commit_title": { + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { "type": "string", - "description": "Title for the merge commit message." + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." }, - "commit_message": { + "archive_url": { "type": "string", - "description": "Commit message for the merge commit." + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." } }, "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] }, - "stack": { - "title": "Pull Request Stack", - "description": "The stack information associated with a pull request.", + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" ], "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The base ref of the stack this pull request belongs to." - }, - "sha": { - "type": "string", - "description": "The base SHA of the stack this pull request belongs to." - } - }, - "required": [ - "ref", - "sha" - ] - }, - "size": { + "id": { "type": "integer", - "description": "The total number of pull requests in the stack." + "description": "The unique identifier of the issue type." }, - "position": { - "type": "integer", - "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." }, - "id": { - "type": "integer", - "description": "The ID of the stack that this pull request belongs to." + "name": { + "type": "string", + "description": "The name of the issue type." }, - "number": { - "type": "integer", - "description": "The number of the stack that this pull request belongs to." + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "base" + "id", + "node_id", + "name", + "description" ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" } }, "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", "title", - "updated_at", + "state", "url", - "user", - "author_association", - "auto_merge" + "html_url", + "repository", + "issue_type" ] } } @@ -11950,30 +13382,303 @@ "self" ] }, - "author_association": { - "title": "author_association", + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "enabled_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "commit_title": { + "type": "string", + "description": "Title for the merge commit message." + }, + "commit_message": { + "type": "string", + "description": "Commit message for the merge commit." + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "stack": { + "title": "Pull Request Stack", + "description": "The stack information associated with a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The base ref of the stack this pull request belongs to." + }, + "sha": { + "type": "string", + "description": "The base SHA of the stack this pull request belongs to." + } + }, + "required": [ + "ref", + "sha" + ] + }, + "size": { + "type": "integer", + "description": "The total number of pull requests in the stack." + }, + "position": { + "type": "integer", + "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + }, + "id": { + "type": "integer", + "description": "The ID of the stack that this pull request belongs to." + }, + "number": { + "type": "integer", + "description": "The number of the stack that this pull request belongs to." + } + }, + "required": [ + "base" + ] + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + } + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merge_commit_sha", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "description": "The title of the issue." }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", "properties": { - "enabled_by": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -12084,114 +13789,314 @@ "url" ] }, - "merge_method": { + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] + "format": "uri", + "description": "The URL to view the repository on GitHub.com." }, - "commit_title": { + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { "type": "string", - "description": "Title for the merge commit message." + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." }, - "commit_message": { + "archive_url": { "type": "string", - "description": "Commit message for the merge commit." + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." } }, "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] }, - "stack": { - "title": "Pull Request Stack", - "description": "The stack information associated with a pull request.", + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" ], "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The base ref of the stack this pull request belongs to." - }, - "sha": { - "type": "string", - "description": "The base SHA of the stack this pull request belongs to." - } - }, - "required": [ - "ref", - "sha" - ] - }, - "size": { + "id": { "type": "integer", - "description": "The total number of pull requests in the stack." + "description": "The unique identifier of the issue type." }, - "position": { - "type": "integer", - "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." }, - "id": { - "type": "integer", - "description": "The ID of the stack that this pull request belongs to." + "name": { + "type": "string", + "description": "The name of the issue type." }, - "number": { - "type": "integer", - "description": "The number of the stack that this pull request belongs to." + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "base" + "id", + "node_id", + "name", + "description" ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" } }, "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", "title", - "updated_at", + "state", "url", - "user", - "author_association", - "auto_merge" + "html_url", + "repository", + "issue_type" ] } } diff --git a/src/rest/data/ghec-2022-11-28/copilot.json b/src/rest/data/ghec-2022-11-28/copilot.json index 8a37d003611e..412481612604 100644 --- a/src/rest/data/ghec-2022-11-28/copilot.json +++ b/src/rest/data/ghec-2022-11-28/copilot.json @@ -1665,10 +1665,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ] } }, { @@ -1759,10 +1763,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ] } }, { @@ -1853,10 +1861,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ] } }, { @@ -7556,10 +7568,17 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise Copilot license management\" enterprise permissions": "read" + }, + { + "\"Enterprise administration\" enterprise permissions": "read" + } + ] } }, { @@ -7907,10 +7926,17 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise Copilot license management\" enterprise permissions": "write" + }, + { + "\"Enterprise administration\" enterprise permissions": "write" + } + ] } }, { @@ -8007,10 +8033,17 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise Copilot license management\" enterprise permissions": "write" + }, + { + "\"Enterprise administration\" enterprise permissions": "write" + } + ] } }, { @@ -8725,10 +8758,17 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise Copilot license management\" enterprise permissions": "read" + }, + { + "\"Enterprise administration\" enterprise permissions": "read" + } + ] } }, { diff --git a/src/rest/data/ghec-2022-11-28/issues.json b/src/rest/data/ghec-2022-11-28/issues.json index 2ba01dfbc206..57e7bad2bbc3 100644 --- a/src/rest/data/ghec-2022-11-28/issues.json +++ b/src/rest/data/ghec-2022-11-28/issues.json @@ -6953,7 +6953,7 @@ }, { "name": "issue_field_values", - "description": "A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Supports both\nuser-owned and organization-owned repositories. Field availability depends\non the owner's issue field visibility settings and the caller's access.\nFor example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.
", + "description": "An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields must be enabled for the repository owner. Field values are silently dropped otherwise.
", "childParamsGroups": [ { "type": "integer", @@ -94663,7 +94663,7 @@ ] } ], - "descriptionHTML": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", + "descriptionHTML": "Add custom field values to an issue. You can set values for issue fields that have been defined for the repository's owner.\nAdding an empty array will clear all existing field values for the issue.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", "codeExamples": [ { "request": { @@ -94968,7 +94968,7 @@ ] } ], - "descriptionHTML": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.
Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", + "descriptionHTML": "Set custom field values for an issue, replacing any existing values. You can set values for issue fields that have been defined for the repository's owner.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.
Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/orgs.json b/src/rest/data/ghec-2022-11-28/orgs.json index e3e2f8c02863..1b9bda7103b0 100644 --- a/src/rest/data/ghec-2022-11-28/orgs.json +++ b/src/rest/data/ghec-2022-11-28/orgs.json @@ -14470,7 +14470,7 @@ "type": "array", "items": { "title": "Issue Field", - "description": "A custom attribute defined at the organization level for attaching structured data to issues.", + "description": "A custom attribute defined by a repository owner for attaching structured data to issues.", "type": [ "object", "null" @@ -14508,10 +14508,11 @@ }, "visibility": { "type": "string", - "description": "The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues).", + "description": "The visibility of the issue field. Organization-owned fields return `organization_members_only` for restricted visibility (visible to organization members and to collaborators on the repository the field is read through), or `all` (visible to all users who can see issues). For create and update requests, use `restricted` instead of the deprecated `organization_members_only` input. Existing REST API versions continue to return `organization_members_only` for restricted organization-owned fields, even when a request uses `restricted`. Any change to this response spelling will be introduced in a future REST API version.", "enum": [ "organization_members_only", - "all" + "all", + "restricted" ] }, "options": { @@ -14670,10 +14671,11 @@ { "type": "string", "name": "visibility", - "description": "The visibility of the issue field. Can be organization_members_only (visible only within the organization) or all (visible to all users who can see issues). Only used when the visibility settings feature is enabled. Defaults to organization_members_only.
The visibility of the issue field. Can be restricted (visible to organization members and to collaborators on the repository the field is read through) or all (visible to all users who can see issues). organization_members_only is deprecated. Use restricted instead. Removal will be announced for a future REST API version; existing REST API versions will continue to support this value. Only used when the visibility settings feature is enabled. Defaults to organization_members_only.
The visibility of the issue field. Can be organization_members_only (visible only within the organization) or all (visible to all users who can see issues). Only used when the visibility settings feature is enabled.
The visibility of the issue field. Can be restricted (visible to organization members and to collaborators on the repository the field is read through) or all (visible to all users who can see issues). organization_members_only is deprecated. Use restricted instead. Removal will be announced for a future REST API version; existing REST API versions will continue to support this value. Only used when the visibility settings feature is enabled.
Whether or not the issue type is enabled at the organization level.
", + "description": "Whether or not the issue type is enabled.
", "isRequired": true }, { @@ -15695,7 +15700,7 @@ { "type": "boolean", "name": "is_enabled", - "description": "Whether or not the issue type is enabled at the organization level.
", + "description": "Whether or not the issue type is enabled.
", "isRequired": true }, { @@ -21298,6 +21303,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -21625,6 +21631,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -22356,6 +22363,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -22682,6 +22690,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", diff --git a/src/rest/data/ghec-2022-11-28/repos.json b/src/rest/data/ghec-2022-11-28/repos.json index bd57dee9b622..bfbe03840adf 100644 --- a/src/rest/data/ghec-2022-11-28/repos.json +++ b/src/rest/data/ghec-2022-11-28/repos.json @@ -1102,7 +1102,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Lists all issue fields for the authenticated user. OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.
Response
", + "example": [ + { + "id": 1, + "node_id": "IFT_kwDNAd3NAZo", + "name": "Text field", + "description": "DRI", + "data_type": "text", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 2, + "node_id": "IFSS_kwDNAd3NAZs", + "name": "Priority", + "description": "Level of importance", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "color": "red" + }, + { + "id": 2, + "name": "Medium", + "color": "yellow" + }, + { + "id": 3, + "name": "Low", + "color": "green" + } + ], + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 3, + "node_id": "IFMS_kwDNAd3NAZt", + "name": "Categories", + "description": "Issue categories", + "data_type": "multi_select", + "options": [ + { + "id": 4, + "name": "Frontend", + "color": "blue" + }, + { + "id": 5, + "name": "Backend", + "color": "green" + }, + { + "id": 6, + "name": "Infrastructure", + "color": "purple" + } + ], + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "User Issue Field", + "description": "A custom attribute defined by a personal account for attaching structured data to issues.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue field." + }, + "data_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + "visibility": { + "type": "string", + "description": "The visibility of the issue field. Can be `restricted` (visible only to the owner and to collaborators on the repository the field is read through) or `all` (visible to all users who can see issues).", + "enum": [ + "restricted", + "all" + ] + }, + "options": { + "description": "Available options for single select and multi select fields.", + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The name of the option." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the option." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the option.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "priority": { + "type": [ + "integer", + "null" + ], + "description": "The priority of the option for ordering." + }, + "created_at": { + "type": "string", + "description": "The time the option was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the option was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "name" + ] + } + }, + "created_at": { + "type": "string", + "description": "The time the issue field was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue field was updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "name", + "data_type" + ] + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/user/issue-fields", + "title": "Create an issue field", + "category": "users", + "subcategory": "issue-fields", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue field.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue field.
" + }, + { + "type": "string", + "name": "data_type", + "description": "The data type of the issue field.
", + "isRequired": true, + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + { + "type": "string", + "name": "visibility", + "description": "The visibility of the issue field. Can be restricted (visible only to the owner and to collaborators on the repository the field is read through) or all (visible to all users who can see issues). Defaults to restricted.
Options for select fields. Required when data_type is 'single_select' or 'multi_select'.
", + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "Name of the option.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the option.
" + }, + { + "type": "string", + "name": "color", + "description": "Color for the option.
", + "isRequired": true, + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ] + }, + { + "type": "integer", + "name": "priority", + "description": "Priority of the option for ordering.
", + "isRequired": true + } + ] + } + ], + "descriptionHTML": "Creates a new issue field for the authenticated user's personal account.
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Response
", + "example": { + "id": 512, + "node_id": "IF_kwDNAd3NAZr", + "name": "Priority", + "description": "Level of importance for the issue", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "description": "High priority", + "color": "red", + "priority": 1, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 2, + "name": "Medium", + "description": "Medium priority", + "color": "yellow", + "priority": 2, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 3, + "name": "Low", + "description": "Low priority", + "color": "green", + "priority": 3, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + } + ], + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + "schema": { + "title": "User Issue Field", + "description": "A custom attribute defined by a personal account for attaching structured data to issues.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue field." + }, + "data_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + "visibility": { + "type": "string", + "description": "The visibility of the issue field. Can be `restricted` (visible only to the owner and to collaborators on the repository the field is read through) or `all` (visible to all users who can see issues).", + "enum": [ + "restricted", + "all" + ] + }, + "options": { + "description": "Available options for single select and multi select fields.", + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The name of the option." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the option." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the option.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "priority": { + "type": [ + "integer", + "null" + ], + "description": "The priority of the option for ordering." + }, + "created_at": { + "type": "string", + "description": "The time the option was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the option was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "name" + ] + } + }, + "created_at": { + "type": "string", + "description": "The time the issue field was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue field was updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "name", + "data_type" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/user/issue-fields/{issue_field_id}", + "title": "Update an issue field", + "category": "users", + "subcategory": "issue-fields", + "parameters": [ + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue field.
" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue field.
" + }, + { + "type": "string", + "name": "visibility", + "description": "The visibility of the issue field. Can be restricted (visible only to the owner and to collaborators on the repository the field is read through) or all (visible to all users who can see issues).
Options for select fields. Only applicable when updating single_select or multi_select fields. When provided, this array replaces the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its id. Options sent without an id are treated as new options and may cause existing options to be deleted and recreated.
The id of an existing option to retain or update. Omit this when creating a new option.
" + }, + { + "type": "string", + "name": "name", + "description": "Name of the option.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the option.
" + }, + { + "type": "string", + "name": "color", + "description": "Color for the option.
", + "isRequired": true, + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ] + }, + { + "type": "integer", + "name": "priority", + "description": "Priority of the option for ordering.
", + "isRequired": true + } + ] + } + ], + "descriptionHTML": "Updates an issue field for the authenticated user.
\nThe authenticated user must own the issue field. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
Response
", + "example": { + "id": 512, + "node_id": "IF_kwDNAd3NAZr", + "name": "Priority", + "description": "Level of importance for the issue", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "description": "High priority", + "color": "red", + "priority": 1, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 2, + "name": "Medium", + "description": "Medium priority", + "color": "yellow", + "priority": 2, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 3, + "name": "Low", + "description": "Low priority", + "color": "green", + "priority": 3, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + } + ], + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + "schema": { + "title": "User Issue Field", + "description": "A custom attribute defined by a personal account for attaching structured data to issues.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue field." + }, + "data_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + "visibility": { + "type": "string", + "description": "The visibility of the issue field. Can be `restricted` (visible only to the owner and to collaborators on the repository the field is read through) or `all` (visible to all users who can see issues).", + "enum": [ + "restricted", + "all" + ] + }, + "options": { + "description": "Available options for single select and multi select fields.", + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The name of the option." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the option." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the option.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "priority": { + "type": [ + "integer", + "null" + ], + "description": "The priority of the option for ordering." + }, + "created_at": { + "type": "string", + "description": "The time the option was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the option was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "name" + ] + } + }, + "created_at": { + "type": "string", + "description": "The time the issue field was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue field was updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "name", + "data_type" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/user/issue-fields/{issue_field_id}", + "title": "Delete an issue field", + "category": "users", + "subcategory": "issue-fields", + "parameters": [ + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Deletes an issue field for the authenticated user.
\nThe authenticated user must own the issue field. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
A header with no content is returned.
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "A header with no content is returned.
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "write" + } + ] + } + } + ], + "issue-types": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/user/issue-types", + "title": "List issue types", + "category": "users", + "subcategory": "issue-types", + "parameters": [], + "bodyParameters": [], + "descriptionHTML": "Lists all issue types for the authenticated user. OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.
Response
", + "example": [ + { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 411, + "node_id": "IT_kwDNAd3NAZs", + "name": "Bug", + "description": "An unexpected problem or behavior", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/user/issue-types", + "title": "Create an issue type", + "category": "users", + "subcategory": "issue-types", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue type.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "Whether or not the issue type is enabled.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue type.
" + }, + { + "type": "string or null", + "name": "color", + "description": "Color for the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + } + ], + "descriptionHTML": "Creates a new issue type for the authenticated user's personal account.
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Response
", + "example": { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + "schema": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/user/issue-types/{issue_type_id}", + "title": "Update an issue type", + "category": "users", + "subcategory": "issue-types", + "parameters": [ + { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue type.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "Whether or not the issue type is enabled.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue type.
" + }, + { + "type": "string or null", + "name": "color", + "description": "Color for the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + } + ], + "descriptionHTML": "Updates an issue type for the authenticated user.
\nThe authenticated user must own the issue type. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
Response
", + "example": { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + "schema": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/user/issue-types/{issue_type_id}", + "title": "Delete an issue type", + "category": "users", + "subcategory": "issue-types", + "parameters": [ + { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Deletes an issue type for the authenticated user.
\nThe authenticated user must own the issue type. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "write" + } + ] + } + } + ], "keys": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghec-2026-03-10/code-scanning.json b/src/rest/data/ghec-2026-03-10/code-scanning.json index 7e2142e43ec9..309d04634caa 100644 --- a/src/rest/data/ghec-2026-03-10/code-scanning.json +++ b/src/rest/data/ghec-2026-03-10/code-scanning.json @@ -1466,7 +1466,8 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "title": "Code scanning AI Scan organization settings", @@ -1480,6 +1481,14 @@ "enabled", "disabled" ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the organization. The organization setting respects enterprise policy, and repositories inherit it: when disabled, repositories cannot enable the full repository AI Scan; when enabled, repositories can still opt out.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } }, "required": [ @@ -1537,7 +1546,16 @@ { "type": "string", "name": "pr_scan", - "description": "Whether AI Scan is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling AI Scan. Enabled organizations enable AI Scan for their repositories, but individual repositories can opt out.
", + "description": "Whether AI Scan on pull requests is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling AI Scan. Enabled organizations enable AI Scan for their repositories, but individual repositories can opt out.
", + "enum": [ + "enabled", + "disabled" + ] + }, + { + "type": "string", + "name": "repository_scan", + "description": "Whether the full repository AI Scan is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling the full repository AI Scan. Enabled organizations enable it for their repositories, but individual repositories can opt out.
", "enum": [ "enabled", "disabled" @@ -1552,7 +1570,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "parameters": { "org": "ORG" @@ -1563,7 +1582,8 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "title": "Code scanning AI Scan organization settings", @@ -1577,6 +1597,14 @@ "enabled", "disabled" ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the organization. The organization setting respects enterprise policy, and repositories inherit it: when disabled, repositories cannot enable the full repository AI Scan; when enabled, repositories can still opt out.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] } }, "required": [ @@ -3114,14 +3142,23 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "description": "AI Scan enablement for a repository.", "type": "object", "properties": { "pr_scan": { - "description": "Whether AI Scan is enabled for the repository.", + "description": "Whether AI Scan on pull requests is enabled for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the repository.", "type": "string", "enum": [ "enabled", @@ -3193,7 +3230,16 @@ { "type": "string", "name": "pr_scan", - "description": "Whether to enable or disable AI Scan for the repository.
", + "description": "Whether to enable or disable AI Scan on pull requests for the repository.
", + "enum": [ + "enabled", + "disabled" + ] + }, + { + "type": "string", + "name": "repository_scan", + "description": "Whether to enable or disable the full repository AI Scan for the repository.
", "enum": [ "enabled", "disabled" @@ -3220,14 +3266,23 @@ "contentType": "application/json", "description": "Response
", "example": { - "pr_scan": "enabled" + "pr_scan": "enabled", + "repository_scan": "enabled" }, "schema": { "description": "AI Scan enablement for a repository.", "type": "object", "properties": { "pr_scan": { - "description": "Whether AI Scan is enabled for the repository.", + "description": "Whether AI Scan on pull requests is enabled for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + }, + "repository_scan": { + "description": "Whether the full repository AI Scan is enabled for the repository.", "type": "string", "enum": [ "enabled", @@ -4209,219 +4264,1123 @@ "url" ] } - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "403", - "description": "Response if GitHub Advanced Security is not enabled for this repository
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "503", - "description": "Service unavailable
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Code scanning alerts\" repository permissions": "read" - } - ] - } - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "title": "Get a code scanning alert", - "category": "code-scanning", - "subcategory": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Gets a single code scanning alert.
\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Response
", - "example": { - "number": 42, - "created_at": "2020-06-19T11:21:34Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", - "html_url": "https://github.com/octocat/hello-world/code-scanning/42", - "state": "dismissed", - "fixed_at": null, - "dismissed_by": { - "login": "octocat", - "id": 54933897, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_at": "2020-02-14T12:29:18Z", - "dismissed_reason": "false positive", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "security_severity_level": "high", - "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", - "name": "js/zipslip", - "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", - "help_uri": "https://codeql.github.com/" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "dismissed", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "spec-main/api-session-spec.ts", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [ - "test" - ] - }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" - }, - "schema": { - "type": "object", - "properties": { - "number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "created_at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "html_url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "instances_url": { + }, + "linked_pull_requests": { + "description": "Pull requests linked to this alert.", + "type": "array", + "items": { + "title": "Pull Requests on Alerts", + "description": "A pull request linked to a code scanning alert.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The number of the linked pull request." + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the linked pull request." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "title": { + "type": "string", + "description": "The title of the linked pull request." + }, + "state": { + "type": "string", + "description": "The state of the referenced pull request.", + "enum": [ + "open", + "closed", + "merged" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time the linked pull request was merged. Null if it has not been merged." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the linked pull request on GitHub." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL for the linked pull request." + }, + "draft": { + "type": "boolean", + "description": "Whether the linked pull request is a draft." + } + }, + "required": [ + "number", + "id", + "repository", + "title", + "state", + "merged_at", + "html_url", + "url", + "draft" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { + "type": "string", + "description": "The title of the issue." + }, + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + }, + "required": [ + "number", + "title", + "state", + "url", + "html_url", + "repository", + "issue_type" + ] + } + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance" + ] + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "403", + "description": "Response if GitHub Advanced Security is not enabled for this repository
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "503", + "description": "Service unavailable
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Code scanning alerts\" repository permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + "title": "Get a code scanning alert", + "category": "code-scanning", + "subcategory": "code-scanning", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.
Gets a single code scanning alert.
\nOAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Response
", + "example": { + "number": 42, + "created_at": "2020-06-19T11:21:34Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/octocat/hello-world/code-scanning/42", + "state": "dismissed", + "fixed_at": null, + "dismissed_by": { + "login": "octocat", + "id": 54933897, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "security_severity_level": "high", + "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", + "name": "js/zipslip", + "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "dismissed", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" + }, + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", "format": "uri", @@ -7780,30 +8739,301 @@ "self" ] }, - "author_association": { - "title": "author_association", + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "enabled_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "commit_title": { + "type": "string", + "description": "Title for the merge commit message." + }, + "commit_message": { + "type": "string", + "description": "Commit message for the merge commit." + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "stack": { + "title": "Pull Request Stack", + "description": "The stack information associated with a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The base ref of the stack this pull request belongs to." + }, + "sha": { + "type": "string", + "description": "The base SHA of the stack this pull request belongs to." + } + }, + "required": [ + "ref", + "sha" + ] + }, + "size": { + "type": "integer", + "description": "The total number of pull requests in the stack." + }, + "position": { + "type": "integer", + "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + }, + "id": { + "type": "integer", + "description": "The ID of the stack that this pull request belongs to." + }, + "number": { + "type": "integer", + "description": "The number of the stack that this pull request belongs to." + } + }, + "required": [ + "base" + ] + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + } + }, + "required": [ + "_links", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "description": "The title of the issue." }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", "properties": { - "enabled_by": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -7914,112 +9144,314 @@ "url" ] }, - "merge_method": { + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] + "format": "uri", + "description": "The URL to view the repository on GitHub.com." }, - "commit_title": { + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { "type": "string", - "description": "Title for the merge commit message." + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." }, - "commit_message": { + "archive_url": { "type": "string", - "description": "Commit message for the merge commit." + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." } }, "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] }, - "stack": { - "title": "Pull Request Stack", - "description": "The stack information associated with a pull request.", + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" ], "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The base ref of the stack this pull request belongs to." - }, - "sha": { - "type": "string", - "description": "The base SHA of the stack this pull request belongs to." - } - }, - "required": [ - "ref", - "sha" - ] - }, - "size": { + "id": { "type": "integer", - "description": "The total number of pull requests in the stack." + "description": "The unique identifier of the issue type." }, - "position": { - "type": "integer", - "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." }, - "id": { - "type": "integer", - "description": "The ID of the stack that this pull request belongs to." + "name": { + "type": "string", + "description": "The name of the issue type." }, - "number": { - "type": "integer", - "description": "The number of the stack that this pull request belongs to." + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "base" + "id", + "node_id", + "name", + "description" ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - } - }, - "required": [ - "_links", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merged_at", - "milestone", - "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", + } + }, + "required": [ + "number", "title", - "updated_at", + "state", "url", - "user", - "author_association", - "auto_merge" + "html_url", + "repository", + "issue_type" ] } } @@ -11636,30 +13068,301 @@ "self" ] }, - "author_association": { - "title": "author_association", + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "enabled_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "commit_title": { + "type": "string", + "description": "Title for the merge commit message." + }, + "commit_message": { + "type": "string", + "description": "Commit message for the merge commit." + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "stack": { + "title": "Pull Request Stack", + "description": "The stack information associated with a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The base ref of the stack this pull request belongs to." + }, + "sha": { + "type": "string", + "description": "The base SHA of the stack this pull request belongs to." + } + }, + "required": [ + "ref", + "sha" + ] + }, + "size": { + "type": "integer", + "description": "The total number of pull requests in the stack." + }, + "position": { + "type": "integer", + "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + }, + "id": { + "type": "integer", + "description": "The ID of the stack that this pull request belongs to." + }, + "number": { + "type": "integer", + "description": "The number of the stack that this pull request belongs to." + } + }, + "required": [ + "base" + ] + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + } + }, + "required": [ + "_links", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "description": "The title of the issue." }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", "properties": { - "enabled_by": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -11770,112 +13473,314 @@ "url" ] }, - "merge_method": { + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] + "format": "uri", + "description": "The URL to view the repository on GitHub.com." }, - "commit_title": { + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { "type": "string", - "description": "Title for the merge commit message." + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." }, - "commit_message": { + "archive_url": { "type": "string", - "description": "Commit message for the merge commit." + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." } }, "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] }, - "stack": { - "title": "Pull Request Stack", - "description": "The stack information associated with a pull request.", + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" ], "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The base ref of the stack this pull request belongs to." - }, - "sha": { - "type": "string", - "description": "The base SHA of the stack this pull request belongs to." - } - }, - "required": [ - "ref", - "sha" - ] - }, - "size": { + "id": { "type": "integer", - "description": "The total number of pull requests in the stack." + "description": "The unique identifier of the issue type." }, - "position": { - "type": "integer", - "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." }, - "id": { - "type": "integer", - "description": "The ID of the stack that this pull request belongs to." + "name": { + "type": "string", + "description": "The name of the issue type." }, - "number": { - "type": "integer", - "description": "The number of the stack that this pull request belongs to." + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "base" + "id", + "node_id", + "name", + "description" ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" } }, "required": [ - "_links", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merged_at", - "milestone", "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", "title", - "updated_at", + "state", "url", - "user", - "author_association", - "auto_merge" + "html_url", + "repository", + "issue_type" ] } } diff --git a/src/rest/data/ghec-2026-03-10/copilot.json b/src/rest/data/ghec-2026-03-10/copilot.json index bc9c75683e97..5ad9aa1ae02e 100644 --- a/src/rest/data/ghec-2026-03-10/copilot.json +++ b/src/rest/data/ghec-2026-03-10/copilot.json @@ -1665,10 +1665,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ] } }, { @@ -1759,10 +1763,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ] } }, { @@ -1853,10 +1861,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise AI controls\" enterprise permissions": "write" + } + ] } }, { @@ -7553,10 +7565,17 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise Copilot license management\" enterprise permissions": "read" + }, + { + "\"Enterprise administration\" enterprise permissions": "read" + } + ] } }, { @@ -7904,10 +7923,17 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise Copilot license management\" enterprise permissions": "write" + }, + { + "\"Enterprise administration\" enterprise permissions": "write" + } + ] } }, { @@ -8004,10 +8030,17 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise Copilot license management\" enterprise permissions": "write" + }, + { + "\"Enterprise administration\" enterprise permissions": "write" + } + ] } }, { @@ -8722,10 +8755,17 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, + "userToServerRest": true, + "serverToServer": true, "fineGrainedPat": false, - "permissions": [] + "permissions": [ + { + "\"Enterprise Copilot license management\" enterprise permissions": "read" + }, + { + "\"Enterprise administration\" enterprise permissions": "read" + } + ] } }, { diff --git a/src/rest/data/ghec-2026-03-10/issues.json b/src/rest/data/ghec-2026-03-10/issues.json index 7c1278c8eace..bb4e9e0ec351 100644 --- a/src/rest/data/ghec-2026-03-10/issues.json +++ b/src/rest/data/ghec-2026-03-10/issues.json @@ -6693,7 +6693,7 @@ }, { "name": "issue_field_values", - "description": "A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Supports both\nuser-owned and organization-owned repositories. Field availability depends\non the owner's issue field visibility settings and the caller's access.\nFor example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.
", + "description": "An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields must be enabled for the repository owner. Field values are silently dropped otherwise.
", "childParamsGroups": [ { "type": "integer", @@ -91983,7 +91983,7 @@ ] } ], - "descriptionHTML": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", + "descriptionHTML": "Add custom field values to an issue. You can set values for issue fields that have been defined for the repository's owner.\nAdding an empty array will clear all existing field values for the issue.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", "codeExamples": [ { "request": { @@ -92288,7 +92288,7 @@ ] } ], - "descriptionHTML": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.
Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", + "descriptionHTML": "Set custom field values for an issue, replacing any existing values. You can set values for issue fields that have been defined for the repository's owner.
\nThis endpoint supports the following field data types:
\ntext: String values for text fieldssingle_select: Option names for single-select fields (must match an existing option name)number: Numeric values for number fieldsdate: ISO 8601 date strings for date fieldsThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.
Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/orgs.json b/src/rest/data/ghec-2026-03-10/orgs.json index 7263656110b8..b476b32b843d 100644 --- a/src/rest/data/ghec-2026-03-10/orgs.json +++ b/src/rest/data/ghec-2026-03-10/orgs.json @@ -14196,7 +14196,7 @@ "type": "array", "items": { "title": "Issue Field", - "description": "A custom attribute defined at the organization level for attaching structured data to issues.", + "description": "A custom attribute defined by a repository owner for attaching structured data to issues.", "type": [ "object", "null" @@ -14234,10 +14234,11 @@ }, "visibility": { "type": "string", - "description": "The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues).", + "description": "The visibility of the issue field. Organization-owned fields return `organization_members_only` for restricted visibility (visible to organization members and to collaborators on the repository the field is read through), or `all` (visible to all users who can see issues). For create and update requests, use `restricted` instead of the deprecated `organization_members_only` input. Existing REST API versions continue to return `organization_members_only` for restricted organization-owned fields, even when a request uses `restricted`. Any change to this response spelling will be introduced in a future REST API version.", "enum": [ "organization_members_only", - "all" + "all", + "restricted" ] }, "options": { @@ -14396,10 +14397,11 @@ { "type": "string", "name": "visibility", - "description": "The visibility of the issue field. Can be organization_members_only (visible only within the organization) or all (visible to all users who can see issues). Only used when the visibility settings feature is enabled. Defaults to organization_members_only.
The visibility of the issue field. Can be restricted (visible to organization members and to collaborators on the repository the field is read through) or all (visible to all users who can see issues). organization_members_only is deprecated. Use restricted instead. Removal will be announced for a future REST API version; existing REST API versions will continue to support this value. Only used when the visibility settings feature is enabled. Defaults to organization_members_only.
The visibility of the issue field. Can be organization_members_only (visible only within the organization) or all (visible to all users who can see issues). Only used when the visibility settings feature is enabled.
The visibility of the issue field. Can be restricted (visible to organization members and to collaborators on the repository the field is read through) or all (visible to all users who can see issues). organization_members_only is deprecated. Use restricted instead. Removal will be announced for a future REST API version; existing REST API versions will continue to support this value. Only used when the visibility settings feature is enabled.
Whether or not the issue type is enabled at the organization level.
", + "description": "Whether or not the issue type is enabled.
", "isRequired": true }, { @@ -15421,7 +15426,7 @@ { "type": "boolean", "name": "is_enabled", - "description": "Whether or not the issue type is enabled at the organization level.
", + "description": "Whether or not the issue type is enabled.
", "isRequired": true }, { @@ -21032,6 +21037,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -21359,6 +21365,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -22090,6 +22097,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -22416,6 +22424,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", diff --git a/src/rest/data/ghec-2026-03-10/repos.json b/src/rest/data/ghec-2026-03-10/repos.json index b952cb48cd25..66c8911f7b4a 100644 --- a/src/rest/data/ghec-2026-03-10/repos.json +++ b/src/rest/data/ghec-2026-03-10/repos.json @@ -1099,7 +1099,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Lists all issue fields for the authenticated user. OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.
Response
", + "example": [ + { + "id": 1, + "node_id": "IFT_kwDNAd3NAZo", + "name": "Text field", + "description": "DRI", + "data_type": "text", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 2, + "node_id": "IFSS_kwDNAd3NAZs", + "name": "Priority", + "description": "Level of importance", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "color": "red" + }, + { + "id": 2, + "name": "Medium", + "color": "yellow" + }, + { + "id": 3, + "name": "Low", + "color": "green" + } + ], + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 3, + "node_id": "IFMS_kwDNAd3NAZt", + "name": "Categories", + "description": "Issue categories", + "data_type": "multi_select", + "options": [ + { + "id": 4, + "name": "Frontend", + "color": "blue" + }, + { + "id": 5, + "name": "Backend", + "color": "green" + }, + { + "id": 6, + "name": "Infrastructure", + "color": "purple" + } + ], + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "User Issue Field", + "description": "A custom attribute defined by a personal account for attaching structured data to issues.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue field." + }, + "data_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + "visibility": { + "type": "string", + "description": "The visibility of the issue field. Can be `restricted` (visible only to the owner and to collaborators on the repository the field is read through) or `all` (visible to all users who can see issues).", + "enum": [ + "restricted", + "all" + ] + }, + "options": { + "description": "Available options for single select and multi select fields.", + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The name of the option." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the option." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the option.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "priority": { + "type": [ + "integer", + "null" + ], + "description": "The priority of the option for ordering." + }, + "created_at": { + "type": "string", + "description": "The time the option was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the option was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "name" + ] + } + }, + "created_at": { + "type": "string", + "description": "The time the issue field was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue field was updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "name", + "data_type" + ] + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/user/issue-fields", + "title": "Create an issue field", + "category": "users", + "subcategory": "issue-fields", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue field.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue field.
" + }, + { + "type": "string", + "name": "data_type", + "description": "The data type of the issue field.
", + "isRequired": true, + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + { + "type": "string", + "name": "visibility", + "description": "The visibility of the issue field. Can be restricted (visible only to the owner and to collaborators on the repository the field is read through) or all (visible to all users who can see issues). Defaults to restricted.
Options for select fields. Required when data_type is 'single_select' or 'multi_select'.
", + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "Name of the option.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the option.
" + }, + { + "type": "string", + "name": "color", + "description": "Color for the option.
", + "isRequired": true, + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ] + }, + { + "type": "integer", + "name": "priority", + "description": "Priority of the option for ordering.
", + "isRequired": true + } + ] + } + ], + "descriptionHTML": "Creates a new issue field for the authenticated user's personal account.
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Response
", + "example": { + "id": 512, + "node_id": "IF_kwDNAd3NAZr", + "name": "Priority", + "description": "Level of importance for the issue", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "description": "High priority", + "color": "red", + "priority": 1, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 2, + "name": "Medium", + "description": "Medium priority", + "color": "yellow", + "priority": 2, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 3, + "name": "Low", + "description": "Low priority", + "color": "green", + "priority": 3, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + } + ], + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + "schema": { + "title": "User Issue Field", + "description": "A custom attribute defined by a personal account for attaching structured data to issues.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue field." + }, + "data_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + "visibility": { + "type": "string", + "description": "The visibility of the issue field. Can be `restricted` (visible only to the owner and to collaborators on the repository the field is read through) or `all` (visible to all users who can see issues).", + "enum": [ + "restricted", + "all" + ] + }, + "options": { + "description": "Available options for single select and multi select fields.", + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The name of the option." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the option." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the option.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "priority": { + "type": [ + "integer", + "null" + ], + "description": "The priority of the option for ordering." + }, + "created_at": { + "type": "string", + "description": "The time the option was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the option was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "name" + ] + } + }, + "created_at": { + "type": "string", + "description": "The time the issue field was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue field was updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "name", + "data_type" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/user/issue-fields/{issue_field_id}", + "title": "Update an issue field", + "category": "users", + "subcategory": "issue-fields", + "parameters": [ + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue field.
" + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue field.
" + }, + { + "type": "string", + "name": "visibility", + "description": "The visibility of the issue field. Can be restricted (visible only to the owner and to collaborators on the repository the field is read through) or all (visible to all users who can see issues).
Options for select fields. Only applicable when updating single_select or multi_select fields. When provided, this array replaces the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its id. Options sent without an id are treated as new options and may cause existing options to be deleted and recreated.
The id of an existing option to retain or update. Omit this when creating a new option.
" + }, + { + "type": "string", + "name": "name", + "description": "Name of the option.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the option.
" + }, + { + "type": "string", + "name": "color", + "description": "Color for the option.
", + "isRequired": true, + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ] + }, + { + "type": "integer", + "name": "priority", + "description": "Priority of the option for ordering.
", + "isRequired": true + } + ] + } + ], + "descriptionHTML": "Updates an issue field for the authenticated user.
\nThe authenticated user must own the issue field. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
Response
", + "example": { + "id": 512, + "node_id": "IF_kwDNAd3NAZr", + "name": "Priority", + "description": "Level of importance for the issue", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "description": "High priority", + "color": "red", + "priority": 1, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 2, + "name": "Medium", + "description": "Medium priority", + "color": "yellow", + "priority": 2, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 3, + "name": "Low", + "description": "Low priority", + "color": "green", + "priority": 3, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + } + ], + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + "schema": { + "title": "User Issue Field", + "description": "A custom attribute defined by a personal account for attaching structured data to issues.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue field." + }, + "data_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "multi_select", + "number" + ] + }, + "visibility": { + "type": "string", + "description": "The visibility of the issue field. Can be `restricted` (visible only to the owner and to collaborators on the repository the field is read through) or `all` (visible to all users who can see issues).", + "enum": [ + "restricted", + "all" + ] + }, + "options": { + "description": "Available options for single select and multi select fields.", + "type": [ + "array", + "null" + ], + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The name of the option." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the option." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the option.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "priority": { + "type": [ + "integer", + "null" + ], + "description": "The priority of the option for ordering." + }, + "created_at": { + "type": "string", + "description": "The time the option was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the option was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "name" + ] + } + }, + "created_at": { + "type": "string", + "description": "The time the issue field was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue field was updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "name", + "data_type" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/user/issue-fields/{issue_field_id}", + "title": "Delete an issue field", + "category": "users", + "subcategory": "issue-fields", + "parameters": [ + { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Deletes an issue field for the authenticated user.
\nThe authenticated user must own the issue field. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
A header with no content is returned.
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "A header with no content is returned.
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Fields\" user permissions": "write" + } + ] + } + } + ], + "issue-types": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/user/issue-types", + "title": "List issue types", + "category": "users", + "subcategory": "issue-types", + "parameters": [], + "bodyParameters": [], + "descriptionHTML": "Lists all issue types for the authenticated user. OAuth app tokens and personal access tokens (classic) need the read:user scope to use this endpoint.
Response
", + "example": [ + { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 411, + "node_id": "IT_kwDNAd3NAZs", + "name": "Bug", + "description": "An unexpected problem or behavior", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/user/issue-types", + "title": "Create an issue type", + "category": "users", + "subcategory": "issue-types", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue type.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "Whether or not the issue type is enabled.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue type.
" + }, + { + "type": "string or null", + "name": "color", + "description": "Color for the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + } + ], + "descriptionHTML": "Creates a new issue type for the authenticated user's personal account.
\nOAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.
Response
", + "example": { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + "schema": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/user/issue-types/{issue_type_id}", + "title": "Update an issue type", + "category": "users", + "subcategory": "issue-types", + "parameters": [ + { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "description": "Name of the issue type.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_enabled", + "description": "Whether or not the issue type is enabled.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the issue type.
" + }, + { + "type": "string or null", + "name": "color", + "description": "Color for the issue type.
", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + } + ], + "descriptionHTML": "Updates an issue type for the authenticated user.
\nThe authenticated user must own the issue type. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
Response
", + "example": { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + "schema": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/user/issue-types/{issue_type_id}", + "title": "Delete an issue type", + "category": "users", + "subcategory": "issue-types", + "parameters": [ + { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Deletes an issue type for the authenticated user.
\nThe authenticated user must own the issue type. OAuth app tokens and personal access tokens (classic)\nneed the user scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Issue Types\" user permissions": "write" + } + ] + } + } + ], "keys": [ { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghes-3.19-2022-11-28/code-scanning.json b/src/rest/data/ghes-3.19-2022-11-28/code-scanning.json index 4f1b2630ddda..f2bfc75dedb0 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/code-scanning.json +++ b/src/rest/data/ghes-3.19-2022-11-28/code-scanning.json @@ -3823,6 +3823,910 @@ "url" ] } + }, + "linked_pull_requests": { + "description": "Pull requests linked to this alert.", + "type": "array", + "items": { + "title": "Pull Requests on Alerts", + "description": "A pull request linked to a code scanning alert.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The number of the linked pull request." + }, + "id": { + "type": "integer", + "format": "int64", + "description": "The ID of the linked pull request." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "title": { + "type": "string", + "description": "The title of the linked pull request." + }, + "state": { + "type": "string", + "description": "The state of the referenced pull request.", + "enum": [ + "open", + "closed", + "merged" + ] + }, + "merged_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time the linked pull request was merged. Null if it has not been merged." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the linked pull request on GitHub." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL for the linked pull request." + }, + "draft": { + "type": "boolean", + "description": "Whether the linked pull request is a draft." + } + }, + "required": [ + "number", + "id", + "repository", + "title", + "state", + "merged_at", + "html_url", + "url", + "draft" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { + "type": "string", + "description": "The title of the issue." + }, + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + }, + "required": [ + "number", + "title", + "state", + "url", + "html_url", + "repository", + "issue_type" + ] + } } }, "required": [ @@ -7541,30 +8445,303 @@ "self" ] }, - "author_association": { - "title": "author_association", + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "enabled_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "commit_title": { + "type": "string", + "description": "Title for the merge commit message." + }, + "commit_message": { + "type": "string", + "description": "Commit message for the merge commit." + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "stack": { + "title": "Pull Request Stack", + "description": "The stack information associated with a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The base ref of the stack this pull request belongs to." + }, + "sha": { + "type": "string", + "description": "The base SHA of the stack this pull request belongs to." + } + }, + "required": [ + "ref", + "sha" + ] + }, + "size": { + "type": "integer", + "description": "The total number of pull requests in the stack." + }, + "position": { + "type": "integer", + "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + }, + "id": { + "type": "integer", + "description": "The ID of the stack that this pull request belongs to." + }, + "number": { + "type": "integer", + "description": "The number of the stack that this pull request belongs to." + } + }, + "required": [ + "base" + ] + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + } + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merge_commit_sha", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "description": "The title of the issue." }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", "properties": { - "enabled_by": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -7675,114 +8852,314 @@ "url" ] }, - "merge_method": { + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] + "format": "uri", + "description": "The URL to view the repository on GitHub.com." }, - "commit_title": { + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { "type": "string", - "description": "Title for the merge commit message." + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." }, - "commit_message": { + "archive_url": { "type": "string", - "description": "Commit message for the merge commit." + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." } }, "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] }, - "stack": { - "title": "Pull Request Stack", - "description": "The stack information associated with a pull request.", + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" ], "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The base ref of the stack this pull request belongs to." - }, - "sha": { - "type": "string", - "description": "The base SHA of the stack this pull request belongs to." - } - }, - "required": [ - "ref", - "sha" - ] - }, - "size": { + "id": { "type": "integer", - "description": "The total number of pull requests in the stack." + "description": "The unique identifier of the issue type." }, - "position": { - "type": "integer", - "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." }, - "id": { - "type": "integer", - "description": "The ID of the stack that this pull request belongs to." + "name": { + "type": "string", + "description": "The name of the issue type." }, - "number": { - "type": "integer", - "description": "The number of the stack that this pull request belongs to." - } - }, - "required": [ - "base" - ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" - } - }, - "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + } + }, + "required": [ "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", "title", - "updated_at", + "state", "url", - "user", - "author_association", - "auto_merge" + "html_url", + "repository", + "issue_type" ] } } @@ -11547,30 +12924,303 @@ "self" ] }, - "author_association": { - "title": "author_association", + "author_association": { + "title": "author_association", + "type": "string", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "enabled_by": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "commit_title": { + "type": "string", + "description": "Title for the merge commit message." + }, + "commit_message": { + "type": "string", + "description": "Commit message for the merge commit." + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "stack": { + "title": "Pull Request Stack", + "description": "The stack information associated with a pull request.", + "type": [ + "object", + "null" + ], + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The base ref of the stack this pull request belongs to." + }, + "sha": { + "type": "string", + "description": "The base SHA of the stack this pull request belongs to." + } + }, + "required": [ + "ref", + "sha" + ] + }, + "size": { + "type": "integer", + "description": "The total number of pull requests in the stack." + }, + "position": { + "type": "integer", + "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + }, + "id": { + "type": "integer", + "description": "The ID of the stack that this pull request belongs to." + }, + "number": { + "type": "integer", + "description": "The number of the stack that this pull request belongs to." + } + }, + "required": [ + "base" + ] + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + } + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merge_commit_sha", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + } + }, + "linked_issues": { + "description": "Issues linked to this alert.", + "type": "array", + "items": { + "description": "A GitHub issue linked to a code scanning alert. The issue may belong to a different repository.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The issue number." + }, + "title": { "type": "string", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "description": "The title of the issue." }, - "auto_merge": { - "title": "Auto merge", - "description": "The status of auto merging a pull request.", - "type": [ - "object", - "null" - ], + "state": { + "type": "string", + "description": "The state of the issue." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the issue." + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL to view the issue on GitHub." + }, + "repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", "properties": { - "enabled_by": { + "id": { + "type": "integer", + "format": "int64", + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "description": "The full, globally unique, name of the repository." + }, + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -11681,114 +13331,314 @@ "url" ] }, - "merge_method": { + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { "type": "string", - "description": "The merge method to use.", - "enum": [ - "merge", - "squash", - "rebase" - ] + "format": "uri", + "description": "The URL to view the repository on GitHub.com." }, - "commit_title": { + "description": { + "type": [ + "string", + "null" + ], + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { "type": "string", - "description": "Title for the merge commit message." + "format": "uri", + "description": "The URL to get more information about the repository from the GitHub API." }, - "commit_message": { + "archive_url": { "type": "string", - "description": "Commit message for the merge commit." + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "description": "The API URL to list the hooks on the repository." } }, "required": [ - "enabled_by", - "merge_method", - "commit_title", - "commit_message" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] }, - "stack": { - "title": "Pull Request Stack", - "description": "The stack information associated with a pull request.", + "issue_type": { + "title": "Issue Type", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" ], "properties": { - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The base ref of the stack this pull request belongs to." - }, - "sha": { - "type": "string", - "description": "The base SHA of the stack this pull request belongs to." - } - }, - "required": [ - "ref", - "sha" - ] - }, - "size": { + "id": { "type": "integer", - "description": "The total number of pull requests in the stack." + "description": "The unique identifier of the issue type." }, - "position": { - "type": "integer", - "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." }, - "id": { - "type": "integer", - "description": "The ID of the stack that this pull request belongs to." + "name": { + "type": "string", + "description": "The name of the issue type." }, - "number": { - "type": "integer", - "description": "The number of the stack that this pull request belongs to." + "description": { + "type": [ + "string", + "null" + ], + "description": "The description of the issue type." + }, + "color": { + "type": [ + "string", + "null" + ], + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple", + null + ] + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." } }, "required": [ - "base" + "id", + "node_id", + "name", + "description" ] - }, - "draft": { - "description": "Indicates whether or not the pull request is a draft.", - "type": "boolean" } }, "required": [ - "_links", - "assignee", - "labels", - "base", - "body", - "closed_at", - "comments_url", - "commits_url", - "created_at", - "diff_url", - "head", - "html_url", - "id", - "node_id", - "issue_url", - "merge_commit_sha", - "merged_at", - "milestone", "number", - "patch_url", - "review_comment_url", - "review_comments_url", - "statuses_url", - "state", - "locked", "title", - "updated_at", + "state", "url", - "user", - "author_association", - "auto_merge" + "html_url", + "repository", + "issue_type" ] } } diff --git a/src/rest/data/ghes-3.19-2022-11-28/issues.json b/src/rest/data/ghes-3.19-2022-11-28/issues.json index d31d5480681d..2741189e38da 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/issues.json +++ b/src/rest/data/ghes-3.19-2022-11-28/issues.json @@ -6953,7 +6953,7 @@ }, { "name": "issue_field_values", - "description": "A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Supports both\nuser-owned and organization-owned repositories. Field availability depends\non the owner's issue field visibility settings and the caller's access.\nFor example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.
", + "description": "An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields must be enabled for the repository owner. Field values are silently dropped otherwise.
", "childParamsGroups": [ { "type": "integer", diff --git a/src/rest/data/ghes-3.19-2022-11-28/orgs.json b/src/rest/data/ghes-3.19-2022-11-28/orgs.json index 80f4680ce483..67abc02266de 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.19-2022-11-28/orgs.json @@ -9709,6 +9709,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -10036,6 +10037,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -10767,6 +10769,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -11093,6 +11096,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", diff --git a/src/rest/data/ghes-3.19-2022-11-28/repos.json b/src/rest/data/ghes-3.19-2022-11-28/repos.json index 42d22e740cb8..a75eafebab82 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/repos.json +++ b/src/rest/data/ghes-3.19-2022-11-28/repos.json @@ -1013,7 +1013,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Supports both\nuser-owned and organization-owned repositories. Field availability depends\non the owner's issue field visibility settings and the caller's access.\nFor example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.
", + "description": "An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields must be enabled for the repository owner. Field values are silently dropped otherwise.
", "childParamsGroups": [ { "type": "integer", diff --git a/src/rest/data/ghes-3.20-2022-11-28/orgs.json b/src/rest/data/ghes-3.20-2022-11-28/orgs.json index e10316b67e3d..3a17799836b2 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.20-2022-11-28/orgs.json @@ -10909,6 +10909,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -11236,6 +11237,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -11967,6 +11969,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -12293,6 +12296,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", diff --git a/src/rest/data/ghes-3.20-2022-11-28/repos.json b/src/rest/data/ghes-3.20-2022-11-28/repos.json index eef844dce6dd..70f162aca9db 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/repos.json +++ b/src/rest/data/ghes-3.20-2022-11-28/repos.json @@ -1013,7 +1013,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Supports both\nuser-owned and organization-owned repositories. Field availability depends\non the owner's issue field visibility settings and the caller's access.\nFor example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.
", + "description": "An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields must be enabled for the repository owner. Field values are silently dropped otherwise.
", "childParamsGroups": [ { "type": "integer", diff --git a/src/rest/data/ghes-3.21-2022-11-28/orgs.json b/src/rest/data/ghes-3.21-2022-11-28/orgs.json index f5f91a8cbcca..9f0d18af7a8d 100644 --- a/src/rest/data/ghes-3.21-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.21-2022-11-28/orgs.json @@ -11210,6 +11210,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -11537,6 +11538,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -12268,6 +12270,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -12594,6 +12597,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", diff --git a/src/rest/data/ghes-3.21-2022-11-28/repos.json b/src/rest/data/ghes-3.21-2022-11-28/repos.json index 6e75edf62143..10c27ccb8f0b 100644 --- a/src/rest/data/ghes-3.21-2022-11-28/repos.json +++ b/src/rest/data/ghes-3.21-2022-11-28/repos.json @@ -1070,7 +1070,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Supports both\nuser-owned and organization-owned repositories. Field availability depends\non the owner's issue field visibility settings and the caller's access.\nFor example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.
", + "description": "An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields must be enabled for the repository owner. Field values are silently dropped otherwise.
", "childParamsGroups": [ { "type": "integer", diff --git a/src/rest/data/ghes-3.21-2026-03-10/orgs.json b/src/rest/data/ghes-3.21-2026-03-10/orgs.json index 43bedb8ab00c..cf1894dc2b62 100644 --- a/src/rest/data/ghes-3.21-2026-03-10/orgs.json +++ b/src/rest/data/ghes-3.21-2026-03-10/orgs.json @@ -10985,6 +10985,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -11312,6 +11313,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -12043,6 +12045,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -12369,6 +12372,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", diff --git a/src/rest/data/ghes-3.21-2026-03-10/repos.json b/src/rest/data/ghes-3.21-2026-03-10/repos.json index 7f24a110904d..306efcfe22c5 100644 --- a/src/rest/data/ghes-3.21-2026-03-10/repos.json +++ b/src/rest/data/ghes-3.21-2026-03-10/repos.json @@ -1067,7 +1067,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Supports both\nuser-owned and organization-owned repositories. Field availability depends\non the owner's issue field visibility settings and the caller's access.\nFor example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.
", + "description": "An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields must be enabled for the repository owner. Field values are silently dropped otherwise.
", "childParamsGroups": [ { "type": "integer", diff --git a/src/rest/data/ghes-3.22-2022-11-28/orgs.json b/src/rest/data/ghes-3.22-2022-11-28/orgs.json index f041b90d88a9..0e02faf76bcf 100644 --- a/src/rest/data/ghes-3.22-2022-11-28/orgs.json +++ b/src/rest/data/ghes-3.22-2022-11-28/orgs.json @@ -11219,6 +11219,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -11546,6 +11547,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -12277,6 +12279,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -12603,6 +12606,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", diff --git a/src/rest/data/ghes-3.22-2022-11-28/repos.json b/src/rest/data/ghes-3.22-2022-11-28/repos.json index 4312135b6832..5bbaf1d6f8e3 100644 --- a/src/rest/data/ghes-3.22-2022-11-28/repos.json +++ b/src/rest/data/ghes-3.22-2022-11-28/repos.json @@ -1079,7 +1079,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
A comma-separated list of issue field filters in field_slug:value format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Supports both\nuser-owned and organization-owned repositories. Field availability depends\non the owner's issue field visibility settings and the caller's access.\nFor example, priority:Urgent,severity:High filters\nissues where the priority field is Urgent AND the severity field is\nHigh.
An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields are only available for organization-owned repositories with the feature enabled. Field values are silently dropped otherwise.
", + "description": "An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Issue fields must be enabled for the repository owner. Field values are silently dropped otherwise.
", "childParamsGroups": [ { "type": "integer", diff --git a/src/rest/data/ghes-3.22-2026-03-10/orgs.json b/src/rest/data/ghes-3.22-2026-03-10/orgs.json index b26c4c32baf6..d395fd54d979 100644 --- a/src/rest/data/ghes-3.22-2026-03-10/orgs.json +++ b/src/rest/data/ghes-3.22-2026-03-10/orgs.json @@ -10994,6 +10994,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -11321,6 +11322,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -12052,6 +12054,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", @@ -12378,6 +12381,7 @@ "enum": [ "read", "triage", + "moderate", "write", "maintain", "admin", diff --git a/src/rest/data/ghes-3.22-2026-03-10/repos.json b/src/rest/data/ghes-3.22-2026-03-10/repos.json index ed8a2851abb7..d9bd16eaad96 100644 --- a/src/rest/data/ghes-3.22-2026-03-10/repos.json +++ b/src/rest/data/ghes-3.22-2026-03-10/repos.json @@ -1076,7 +1076,7 @@ { "type": "boolean", "name": "use_squash_pr_title_as_default", - "description": "Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. **This property is closing down. Please use squash_merge_commit_title instead.
Either true to allow squash-merge commits to use pull request title, or false to use commit message. This property is closing down. Please use squash_merge_commit_title instead.
| + {column.sortable ? ( + + ) : ( + column.header + )} + | + ) + })} +|
|---|---|
| + {column.renderCell(row)} + | + ) : ( +{column.renderCell(row)} | + ), + )} +
- {cleanSecretType}
- {row.isduplicate && (
- <>
- {', '}
- {t('token_versions')}
- >
- )}
-
+ {cleanSecretType}
+ {row.isduplicate && (
+ <>
+ {', '}
+ {t('token_versions')}
+ >
+ )}
+