1
0
mirror of synced 2026-01-04 09:06:46 -05:00

Update OpenAPI Descriptions (#25446)

This commit is contained in:
github-openapi-bot
2022-02-16 23:09:40 -06:00
committed by GitHub
parent d8011df177
commit f0bcb98c75
14 changed files with 2064 additions and 1904 deletions

View File

@@ -6598,19 +6598,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "permissions"
},
"slug": "get-github-actions-permissions-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "permissions",
"subcategoryLabel": "Permissions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
@@ -6659,7 +6659,7 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-enterprise"
},
"requestBody": {
"required": true,
@@ -6711,14 +6711,14 @@
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "permissions"
},
"slug": "set-github-actions-permissions-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "permissions",
"subcategoryLabel": "Permissions",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
@@ -6816,19 +6816,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "permissions"
},
"slug": "list-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "permissions",
"subcategoryLabel": "Permissions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
@@ -6877,7 +6877,7 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise"
},
"requestBody": {
"required": true,
@@ -6916,14 +6916,14 @@
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "permissions"
},
"slug": "set-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "permissions",
"subcategoryLabel": "Permissions",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
@@ -6996,19 +6996,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#enable-a-selected-organization-for-github-actions-in-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "permissions"
},
"slug": "enable-a-selected-organization-for-github-actions-in-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "permissions",
"subcategoryLabel": "Permissions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
@@ -7066,19 +7066,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#disable-a-selected-organization-for-github-actions-in-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "permissions"
},
"slug": "disable-a-selected-organization-for-github-actions-in-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "permissions",
"subcategoryLabel": "Permissions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
@@ -7126,19 +7126,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#get-allowed-actions-for-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "permissions"
},
"slug": "get-allowed-actions-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "permissions",
"subcategoryLabel": "Permissions",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
@@ -7187,7 +7187,7 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-enterprise"
},
"requestBody": {
"required": true,
@@ -7246,14 +7246,14 @@
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "permissions"
},
"slug": "set-allowed-actions-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "permissions",
"subcategoryLabel": "Permissions",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
@@ -7353,19 +7353,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#list-self-hosted-runner-groups-for-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runner-groups"
},
"slug": "list-self-hosted-runner-groups-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runner-groups",
"subcategoryLabel": "Self hosted runner groups",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists all self-hosted runner groups for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -7414,7 +7414,7 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#create-self-hosted-runner-group-for-an-enterprise"
},
"requestBody": {
"required": true,
@@ -7504,14 +7504,14 @@
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runner-groups"
},
"slug": "create-a-self-hosted-runner-group-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runner-groups",
"subcategoryLabel": "Self hosted runner groups",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Creates a new self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -7630,19 +7630,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-group-for-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runner-groups"
},
"slug": "get-a-self-hosted-runner-group-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runner-groups",
"subcategoryLabel": "Self hosted runner groups",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -7701,7 +7701,7 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#update-a-self-hosted-runner-group-for-an-enterprise"
},
"requestBody": {
"required": false,
@@ -7755,14 +7755,14 @@
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runner-groups"
},
"slug": "update-a-self-hosted-runner-group-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runner-groups",
"subcategoryLabel": "Self hosted runner groups",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -7856,19 +7856,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-group-from-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runner-groups"
},
"slug": "delete-a-self-hosted-runner-group-from-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runner-groups",
"subcategoryLabel": "Self hosted runner groups",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -7946,19 +7946,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise"
"url": "https://docs.github.com/rest/reference/actions#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runner-groups"
},
"slug": "list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runner-groups",
"subcategoryLabel": "Self hosted runner groups",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists the organizations with access to a self-hosted runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -8017,7 +8017,7 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise"
},
"requestBody": {
"required": true,
@@ -8056,14 +8056,14 @@
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runner-groups"
},
"slug": "set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runner-groups",
"subcategoryLabel": "Self hosted runner groups",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -8146,19 +8146,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runner-groups"
},
"slug": "add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runner-groups",
"subcategoryLabel": "Self hosted runner groups",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -8226,19 +8226,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runner-groups"
},
"slug": "remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runner-groups",
"subcategoryLabel": "Self hosted runner groups",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -8316,19 +8316,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-in-a-group-for-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runner-groups"
},
"slug": "list-self-hosted-runners-in-a-group-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runner-groups",
"subcategoryLabel": "Self hosted runner groups",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -8387,7 +8387,7 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-enterprise"
},
"requestBody": {
"required": true,
@@ -8426,14 +8426,14 @@
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runner-groups"
},
"slug": "set-self-hosted-runners-in-a-group-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runner-groups",
"subcategoryLabel": "Self hosted runner groups",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -8516,19 +8516,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#add-a-self-hosted-runner-to-a-group-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#add-a-self-hosted-runner-to-a-group-for-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runner-groups"
},
"slug": "add-a-self-hosted-runner-to-a-group-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runner-groups",
"subcategoryLabel": "Self hosted runner groups",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code>\nscope to use this endpoint.</p>",
@@ -8596,19 +8596,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runner-groups"
},
"slug": "remove-a-self-hosted-runner-from-a-group-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runner-groups",
"subcategoryLabel": "Self hosted runner groups",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -8676,19 +8676,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runners"
},
"slug": "list-self-hosted-runners-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runners",
"subcategoryLabel": "Self hosted runners",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists all self-hosted runners configured for an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -8737,19 +8737,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#list-runner-applications-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runners"
},
"slug": "list-runner-applications-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runners",
"subcategoryLabel": "Self hosted runners",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -8798,19 +8798,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#create-a-registration-token-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#create-a-registration-token-for-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runners"
},
"slug": "create-a-registration-token-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runners",
"subcategoryLabel": "Self hosted runners",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-registration-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-registration-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using registration token</h4>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>",
@@ -8859,19 +8859,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#create-a-remove-token-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#create-a-remove-token-for-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runners"
},
"slug": "create-a-remove-token-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runners",
"subcategoryLabel": "Self hosted runners",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>\n<h4 id=\"example-using-remove-token\"><a aria-hidden=\"\" tabindex=\"-1\" class=\"doctocat-link\" href=\"#example-using-remove-token\"><svg aria-hidden=\"\" role=\"img\" class=\"octicon-link\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\" fill=\"currentColor\" style=\"display:inline-block;user-select:none;vertical-align:middle\"><path fill-rule=\"evenodd\" d=\"M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z\"></path></svg></a>Example using remove token</h4>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>",
@@ -8930,19 +8930,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runners"
},
"slug": "get-a-self-hosted-runner-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runners",
"subcategoryLabel": "Self hosted runners",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -9001,19 +9001,19 @@
],
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#delete-self-hosted-runner-from-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#delete-self-hosted-runner-from-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runners"
},
"slug": "delete-a-self-hosted-runner-from-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runners",
"subcategoryLabel": "Self hosted runners",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -9071,19 +9071,19 @@
"operationId": "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#list-labels-for-a-self-hosted-runner-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-enterprise"
},
"x-github": {
"enabledForGitHubApps": false,
"githubCloudOnly": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runners"
},
"slug": "list-labels-for-a-self-hosted-runner-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runners",
"subcategoryLabel": "Self hosted runners",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists all labels for a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -9147,7 +9147,7 @@
"operationId": "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise"
},
"requestBody": {
"required": true,
@@ -9187,14 +9187,14 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runners"
},
"slug": "add-custom-labels-to-a-self-hosted-runner-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runners",
"subcategoryLabel": "Self hosted runners",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Add custom labels to a self-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -9279,7 +9279,7 @@
"operationId": "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise"
},
"requestBody": {
"required": true,
@@ -9319,14 +9319,14 @@
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runners"
},
"slug": "set-custom-labels-for-a-self-hosted-runner-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runners",
"subcategoryLabel": "Self hosted runners",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an enterprise.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -9411,19 +9411,19 @@
"operationId": "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"category": "enterprise-admin",
"subcategory": "actions"
"category": "actions",
"subcategory": "self-hosted-runners"
},
"slug": "remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise",
"category": "enterprise-admin",
"categoryLabel": "Enterprise admin",
"subcategory": "actions",
"subcategoryLabel": "Actions",
"category": "actions",
"categoryLabel": "Actions",
"subcategory": "self-hosted-runners",
"subcategoryLabel": "Self hosted runners",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Remove all custom labels from a self-hosted runner configured in an\nenterprise. Returns the remaining read-only labels from the runner.</p>\n<p>You must authenticate using an access token with the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
@@ -9502,7 +9502,7 @@
"operationId": "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/enterprise-admin#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise"
"url": "https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise"
},
"x-github": {
"githubCloudOnly": false,
@@ -53267,6 +53267,15 @@
"rawType": "integer",
"rawDescription": "Time in minutes before codespace stops from inactivity",
"childParamsGroups": []
},
"display_name": {
"description": "<p>Display name for this codespace</p>",
"type": "string",
"name": "display_name",
"in": "body",
"rawType": "string",
"rawDescription": "Display name for this codespace",
"childParamsGroups": []
}
}
},
@@ -53334,6 +53343,15 @@
"rawType": "integer",
"rawDescription": "Time in minutes before codespace stops from inactivity",
"childParamsGroups": []
},
{
"description": "<p>Display name for this codespace</p>",
"type": "string",
"name": "display_name",
"in": "body",
"rawType": "string",
"rawDescription": "Display name for this codespace",
"childParamsGroups": []
}
],
"responses": [
@@ -75089,6 +75107,15 @@
"rawType": "integer",
"rawDescription": "Time in minutes before codespace stops from inactivity",
"childParamsGroups": []
},
"display_name": {
"description": "<p>Display name for this codespace</p>",
"type": "string",
"name": "display_name",
"in": "body",
"rawType": "string",
"rawDescription": "Display name for this codespace",
"childParamsGroups": []
}
}
},
@@ -75147,6 +75174,15 @@
"rawType": "integer",
"rawDescription": "Time in minutes before codespace stops from inactivity",
"childParamsGroups": []
},
{
"description": "<p>Display name for this codespace</p>",
"type": "string",
"name": "display_name",
"in": "body",
"rawType": "string",
"rawDescription": "Display name for this codespace",
"childParamsGroups": []
}
],
"responses": [
@@ -93302,6 +93338,15 @@
"rawDescription": "Time in minutes before codespace stops from inactivity",
"childParamsGroups": []
},
"display_name": {
"description": "<p>Display name for this codespace</p>",
"type": "string",
"name": "display_name",
"in": "body",
"rawType": "string",
"rawDescription": "Display name for this codespace",
"childParamsGroups": []
},
"pull_request": {
"required": [
"pull_request_number",
@@ -93573,6 +93618,15 @@
"rawDescription": "Time in minutes before codespace stops from inactivity",
"childParamsGroups": []
},
{
"description": "<p>Display name for this codespace</p>",
"type": "string",
"name": "display_name",
"in": "body",
"rawType": "string",
"rawDescription": "Display name for this codespace",
"childParamsGroups": []
},
{
"required": [
"pull_request_number",
@@ -94563,6 +94617,15 @@
"rawDescription": "A valid machine to transition this codespace to.",
"childParamsGroups": []
},
"display_name": {
"description": "<p>Display name for this codespace</p>",
"type": "string",
"name": "display_name",
"in": "body",
"rawType": "string",
"rawDescription": "Display name for this codespace",
"childParamsGroups": []
},
"recent_folders": {
"description": "<p>Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.</p>",
"type": "array of strings",
@@ -94605,6 +94668,15 @@
"rawDescription": "A valid machine to transition this codespace to.",
"childParamsGroups": []
},
{
"description": "<p>Display name for this codespace</p>",
"type": "string",
"name": "display_name",
"in": "body",
"rawType": "string",
"rawDescription": "Display name for this codespace",
"childParamsGroups": []
},
{
"description": "<p>Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.</p>",
"type": "array of strings",