jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-01 18:05:46 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'main' into repo-sync

Browse Source
This commit is contained in:
Octomerger Bot
2021-11-19 18:22:38 -05:00
committed by GitHub
parent 3471ed7016 623a0cb574
commit baf044b0fe
12 changed files with 1112 additions and 190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
lib/rest/static/decorated/api.github.com.json
View File

@@ -38237,13 +38237,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'</code></pre>"
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":42}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":42}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 'app_id'\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/branches/{branch}/protection'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">required_status_checks</span>: {\n <span class=\"hljs-attr\">strict</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">contexts</span>: [\n <span class=\"hljs-string\">'contexts'</span>\n ],\n <span class=\"hljs-attr\">checks</span>: [\n {\n <span class=\"hljs-attr\">context</span>: <span class=\"hljs-string\">'context'</span>,\n <span class=\"hljs-attr\">app_id</span>: <span class=\"hljs-string\">'app_id'</span>\n }\n ]\n },\n <span class=\"hljs-attr\">enforce_admins</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_pull_request_reviews</span>: {\n <span class=\"hljs-attr\">dismissal_restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ]\n },\n <span class=\"hljs-attr\">dismiss_stale_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">require_code_owner_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_approving_review_count</span>: <span class=\"hljs-number\">42</span>\n },\n <span class=\"hljs-attr\">restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ],\n <span class=\"hljs-attr\">apps</span>: [\n <span class=\"hljs-string\">'apps'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 42\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/branches/{branch}/protection'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">required_status_checks</span>: {\n <span class=\"hljs-attr\">strict</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">contexts</span>: [\n <span class=\"hljs-string\">'contexts'</span>\n ],\n <span class=\"hljs-attr\">checks</span>: [\n {\n <span class=\"hljs-attr\">context</span>: <span class=\"hljs-string\">'context'</span>,\n <span class=\"hljs-attr\">app_id</span>: <span class=\"hljs-number\">42</span>\n }\n ]\n },\n <span class=\"hljs-attr\">enforce_admins</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_pull_request_reviews</span>: {\n <span class=\"hljs-attr\">dismissal_restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ]\n },\n <span class=\"hljs-attr\">dismiss_stale_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">require_code_owner_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_approving_review_count</span>: <span class=\"hljs-number\">42</span>\n },\n <span class=\"hljs-attr\">restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ],\n <span class=\"hljs-attr\">apps</span>: [\n <span class=\"hljs-string\">'apps'</span>\n ]\n }\n})\n</code></pre>"
}
],
"summary": "Update branch protection",
@@ -38305,11 +38305,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38335,11 +38335,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38399,11 +38399,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38429,11 +38429,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38458,11 +38458,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38979,11 +38979,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -39009,11 +39009,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -39073,11 +39073,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -39103,11 +39103,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -39132,11 +39132,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}

48
lib/rest/static/decorated/ghes-3.0.json
View File

@@ -36135,13 +36135,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'</code></pre>"
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":42}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":42}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 'app_id'\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/branches/{branch}/protection'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">required_status_checks</span>: {\n <span class=\"hljs-attr\">strict</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">contexts</span>: [\n <span class=\"hljs-string\">'contexts'</span>\n ],\n <span class=\"hljs-attr\">checks</span>: [\n {\n <span class=\"hljs-attr\">context</span>: <span class=\"hljs-string\">'context'</span>,\n <span class=\"hljs-attr\">app_id</span>: <span class=\"hljs-string\">'app_id'</span>\n }\n ]\n },\n <span class=\"hljs-attr\">enforce_admins</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_pull_request_reviews</span>: {\n <span class=\"hljs-attr\">dismissal_restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ]\n },\n <span class=\"hljs-attr\">dismiss_stale_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">require_code_owner_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_approving_review_count</span>: <span class=\"hljs-number\">42</span>\n },\n <span class=\"hljs-attr\">restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ],\n <span class=\"hljs-attr\">apps</span>: [\n <span class=\"hljs-string\">'apps'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 42\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/branches/{branch}/protection'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">required_status_checks</span>: {\n <span class=\"hljs-attr\">strict</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">contexts</span>: [\n <span class=\"hljs-string\">'contexts'</span>\n ],\n <span class=\"hljs-attr\">checks</span>: [\n {\n <span class=\"hljs-attr\">context</span>: <span class=\"hljs-string\">'context'</span>,\n <span class=\"hljs-attr\">app_id</span>: <span class=\"hljs-number\">42</span>\n }\n ]\n },\n <span class=\"hljs-attr\">enforce_admins</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_pull_request_reviews</span>: {\n <span class=\"hljs-attr\">dismissal_restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ]\n },\n <span class=\"hljs-attr\">dismiss_stale_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">require_code_owner_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_approving_review_count</span>: <span class=\"hljs-number\">42</span>\n },\n <span class=\"hljs-attr\">restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ],\n <span class=\"hljs-attr\">apps</span>: [\n <span class=\"hljs-string\">'apps'</span>\n ]\n }\n})\n</code></pre>"
}
],
"summary": "Update branch protection",
@@ -36203,11 +36203,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -36233,11 +36233,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -36297,11 +36297,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -36327,11 +36327,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -36356,11 +36356,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -36885,11 +36885,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -36915,11 +36915,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -36979,11 +36979,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37009,11 +37009,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37038,11 +37038,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}

48
lib/rest/static/decorated/ghes-3.1.json
View File

@@ -36257,13 +36257,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'</code></pre>"
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":42}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":42}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 'app_id'\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/branches/{branch}/protection'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">required_status_checks</span>: {\n <span class=\"hljs-attr\">strict</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">contexts</span>: [\n <span class=\"hljs-string\">'contexts'</span>\n ],\n <span class=\"hljs-attr\">checks</span>: [\n {\n <span class=\"hljs-attr\">context</span>: <span class=\"hljs-string\">'context'</span>,\n <span class=\"hljs-attr\">app_id</span>: <span class=\"hljs-string\">'app_id'</span>\n }\n ]\n },\n <span class=\"hljs-attr\">enforce_admins</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_pull_request_reviews</span>: {\n <span class=\"hljs-attr\">dismissal_restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ]\n },\n <span class=\"hljs-attr\">dismiss_stale_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">require_code_owner_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_approving_review_count</span>: <span class=\"hljs-number\">42</span>\n },\n <span class=\"hljs-attr\">restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ],\n <span class=\"hljs-attr\">apps</span>: [\n <span class=\"hljs-string\">'apps'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 42\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/branches/{branch}/protection'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">required_status_checks</span>: {\n <span class=\"hljs-attr\">strict</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">contexts</span>: [\n <span class=\"hljs-string\">'contexts'</span>\n ],\n <span class=\"hljs-attr\">checks</span>: [\n {\n <span class=\"hljs-attr\">context</span>: <span class=\"hljs-string\">'context'</span>,\n <span class=\"hljs-attr\">app_id</span>: <span class=\"hljs-number\">42</span>\n }\n ]\n },\n <span class=\"hljs-attr\">enforce_admins</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_pull_request_reviews</span>: {\n <span class=\"hljs-attr\">dismissal_restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ]\n },\n <span class=\"hljs-attr\">dismiss_stale_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">require_code_owner_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_approving_review_count</span>: <span class=\"hljs-number\">42</span>\n },\n <span class=\"hljs-attr\">restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ],\n <span class=\"hljs-attr\">apps</span>: [\n <span class=\"hljs-string\">'apps'</span>\n ]\n }\n})\n</code></pre>"
}
],
"summary": "Update branch protection",
@@ -36325,11 +36325,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -36355,11 +36355,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -36419,11 +36419,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -36449,11 +36449,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -36478,11 +36478,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37007,11 +37007,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37037,11 +37037,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37101,11 +37101,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37131,11 +37131,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37160,11 +37160,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}

48
lib/rest/static/decorated/ghes-3.2.json
View File

@@ -37503,13 +37503,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'</code></pre>"
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":42}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":42}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 'app_id'\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/branches/{branch}/protection'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">required_status_checks</span>: {\n <span class=\"hljs-attr\">strict</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">contexts</span>: [\n <span class=\"hljs-string\">'contexts'</span>\n ],\n <span class=\"hljs-attr\">checks</span>: [\n {\n <span class=\"hljs-attr\">context</span>: <span class=\"hljs-string\">'context'</span>,\n <span class=\"hljs-attr\">app_id</span>: <span class=\"hljs-string\">'app_id'</span>\n }\n ]\n },\n <span class=\"hljs-attr\">enforce_admins</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_pull_request_reviews</span>: {\n <span class=\"hljs-attr\">dismissal_restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ]\n },\n <span class=\"hljs-attr\">dismiss_stale_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">require_code_owner_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_approving_review_count</span>: <span class=\"hljs-number\">42</span>\n },\n <span class=\"hljs-attr\">restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ],\n <span class=\"hljs-attr\">apps</span>: [\n <span class=\"hljs-string\">'apps'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 42\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/branches/{branch}/protection'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">required_status_checks</span>: {\n <span class=\"hljs-attr\">strict</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">contexts</span>: [\n <span class=\"hljs-string\">'contexts'</span>\n ],\n <span class=\"hljs-attr\">checks</span>: [\n {\n <span class=\"hljs-attr\">context</span>: <span class=\"hljs-string\">'context'</span>,\n <span class=\"hljs-attr\">app_id</span>: <span class=\"hljs-number\">42</span>\n }\n ]\n },\n <span class=\"hljs-attr\">enforce_admins</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_pull_request_reviews</span>: {\n <span class=\"hljs-attr\">dismissal_restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ]\n },\n <span class=\"hljs-attr\">dismiss_stale_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">require_code_owner_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_approving_review_count</span>: <span class=\"hljs-number\">42</span>\n },\n <span class=\"hljs-attr\">restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ],\n <span class=\"hljs-attr\">apps</span>: [\n <span class=\"hljs-string\">'apps'</span>\n ]\n }\n})\n</code></pre>"
}
],
"summary": "Update branch protection",
@@ -37571,11 +37571,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37601,11 +37601,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37665,11 +37665,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37695,11 +37695,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37724,11 +37724,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38253,11 +38253,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38283,11 +38283,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38347,11 +38347,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38377,11 +38377,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38406,11 +38406,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}

48
lib/rest/static/decorated/ghes-3.3.json
View File

@@ -37739,13 +37739,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'</code></pre>"
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":42}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":42}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 'app_id'\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/branches/{branch}/protection'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">required_status_checks</span>: {\n <span class=\"hljs-attr\">strict</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">contexts</span>: [\n <span class=\"hljs-string\">'contexts'</span>\n ],\n <span class=\"hljs-attr\">checks</span>: [\n {\n <span class=\"hljs-attr\">context</span>: <span class=\"hljs-string\">'context'</span>,\n <span class=\"hljs-attr\">app_id</span>: <span class=\"hljs-string\">'app_id'</span>\n }\n ]\n },\n <span class=\"hljs-attr\">enforce_admins</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_pull_request_reviews</span>: {\n <span class=\"hljs-attr\">dismissal_restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ]\n },\n <span class=\"hljs-attr\">dismiss_stale_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">require_code_owner_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_approving_review_count</span>: <span class=\"hljs-number\">42</span>\n },\n <span class=\"hljs-attr\">restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ],\n <span class=\"hljs-attr\">apps</span>: [\n <span class=\"hljs-string\">'apps'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 42\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/branches/{branch}/protection'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">required_status_checks</span>: {\n <span class=\"hljs-attr\">strict</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">contexts</span>: [\n <span class=\"hljs-string\">'contexts'</span>\n ],\n <span class=\"hljs-attr\">checks</span>: [\n {\n <span class=\"hljs-attr\">context</span>: <span class=\"hljs-string\">'context'</span>,\n <span class=\"hljs-attr\">app_id</span>: <span class=\"hljs-number\">42</span>\n }\n ]\n },\n <span class=\"hljs-attr\">enforce_admins</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_pull_request_reviews</span>: {\n <span class=\"hljs-attr\">dismissal_restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ]\n },\n <span class=\"hljs-attr\">dismiss_stale_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">require_code_owner_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_approving_review_count</span>: <span class=\"hljs-number\">42</span>\n },\n <span class=\"hljs-attr\">restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ],\n <span class=\"hljs-attr\">apps</span>: [\n <span class=\"hljs-string\">'apps'</span>\n ]\n }\n})\n</code></pre>"
}
],
"summary": "Update branch protection",
@@ -37807,11 +37807,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37837,11 +37837,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37901,11 +37901,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37931,11 +37931,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -37960,11 +37960,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38481,11 +38481,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38511,11 +38511,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38575,11 +38575,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38605,11 +38605,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -38634,11 +38634,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}

385
lib/rest/static/decorated/github.ae.json
View File

@@ -14889,6 +14889,164 @@
"bodyParameters": [],
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>"
},
{
"verb": "get",
"requestPath": "/orgs/{org}/external-group/{group_id}",
"serverUrl": "https://{hostname}/api/v3",
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "group_id",
"description": "group_id parameter",
"in": "path",
"required": true,
"schema": {
"type": "integer"
},
"descriptionHTML": "<p>group_id parameter</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/orgs/ORG/external-group/42",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/orgs/ORG/external-group/42</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /orgs/{org}/external-group/{group_id}', {\n org: 'org',\n group_id: 42\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'GET /orgs/{org}/external-group/{group_id}'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">group_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
}
],
"summary": "Get an external group",
"description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
"tags": [
"teams"
],
"operationId": "teams/external-idp-group-info-for-org",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/teams#external-idp-group-info-for-an-organization"
},
"x-github": {
"githubCloudOnly": true,
"enabledForGitHubApps": true,
"category": "teams",
"subcategory": "external-groups"
},
"slug": "get-an-external-group",
"category": "teams",
"categoryLabel": "Teams",
"subcategory": "external-groups",
"subcategoryLabel": "External groups",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Response",
"payload": "<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"group_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"123\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"group_name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"Octocat admins\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"updated_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2021-01-24T11:31:04-06:00\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"teams\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span>\n <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"team_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"team_name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"team-test\"</span>\n <span class=\"hljs-punctuation\">}</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"team_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">2</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"team_name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"team-test2\"</span>\n <span class=\"hljs-punctuation\">}</span>\n <span class=\"hljs-punctuation\">]</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"members\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span>\n <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"member_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"member_login\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"mona-lisa_eocsaxrs\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"member_name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"Mona Lisa\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"member_email\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"mona_lisa@github.com\"</span>\n <span class=\"hljs-punctuation\">}</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"member_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">2</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"member_login\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"octo-lisa_eocsaxrs\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"member_name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"Octo Lisa\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"member_email\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"octo_lisa@github.com\"</span>\n <span class=\"hljs-punctuation\">}</span>\n <span class=\"hljs-punctuation\">]</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>"
}
]
},
{
"verb": "get",
"requestPath": "/orgs/{org}/external-groups",
"serverUrl": "https://{hostname}/api/v3",
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "per_page",
"description": "Results per page (max 100)",
"in": "query",
"schema": {
"type": "integer",
"default": 30
},
"descriptionHTML": "<p>Results per page (max 100)</p>"
},
{
"name": "page",
"description": "Page token",
"in": "query",
"schema": {
"type": "integer"
},
"descriptionHTML": "<p>Page token</p>"
},
{
"name": "display_name",
"description": "Limits the list to groups containing the text in the group name",
"in": "query",
"schema": {
"type": "string"
},
"descriptionHTML": "<p>Limits the list to groups containing the text in the group name</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/orgs/ORG/external-groups",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/orgs/ORG/external-groups</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /orgs/{org}/external-groups', {\n org: 'org'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'GET /orgs/{org}/external-groups'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>\n})\n</code></pre>"
}
],
"summary": "List external groups in an organization",
"description": "Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub AE generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
"tags": [
"teams"
],
"operationId": "teams/list-external-idp-groups-for-org",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-external-idp-groups-for-an-organization"
},
"x-github": {
"githubCloudOnly": true,
"enabledForGitHubApps": true,
"category": "teams",
"subcategory": "external-groups"
},
"slug": "list-external-groups-in-an-organization",
"category": "teams",
"categoryLabel": "Teams",
"subcategory": "external-groups",
"subcategoryLabel": "External groups",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists external groups available in an organization. You can query the groups using the <code>display_name</code> parameter, only groups with a <code>group_name</code> containing the text provided in the <code>display_name</code> parameter will be returned. You can also limit your page results using the <code>per_page</code> parameter. GitHub AE generates a url-encoded <code>page</code> token using a cursor value for where the next page begins. For more information on cursor pagination, see \"<a href=\"https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89\">Offset and Cursor Pagination explained</a>.\"</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Response",
"payload": "<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"groups\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span>\n <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"group_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"123\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"group_name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"Octocat admins\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"updated_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2021-01-24T11:31:04-06:00\"</span>\n <span class=\"hljs-punctuation\">}</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"group_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"456\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"group_name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"Octocat docs members\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"updated_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2021-03-24T11:31:04-06:00\"</span>\n <span class=\"hljs-punctuation\">}</span>\n <span class=\"hljs-punctuation\">]</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>"
}
]
},
{
"verb": "get",
"requestPath": "/orgs/{org}/hooks",
@@ -20898,6 +21056,185 @@
"bodyParameters": [],
"descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>"
},
{
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups",
"serverUrl": "https://{hostname}/api/v3",
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "team_slug",
"description": "team_slug parameter",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>team_slug parameter</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/external-groups \\\n -d '{\"group_id\":42}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/external-groups \\\n -d '{\"group_id\":42}'</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('PATCH /orgs/{org}/teams/{team_slug}/external-groups', {\n org: 'org',\n team_slug: 'team_slug',\n group_id: 42\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PATCH /orgs/{org}/teams/{team_slug}/external-groups'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">team_slug</span>: <span class=\"hljs-string\">'team_slug'</span>,\n <span class=\"hljs-attr\">group_id</span>: <span class=\"hljs-number\">42</span>\n})\n</code></pre>"
}
],
"summary": "Update the connection between an external group and a team",
"description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
"tags": [
"teams"
],
"operationId": "teams/link-external-idp-group-to-team-for-org",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/teams#link-external-idp-group-team-connection"
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"group_id": {
"type": "integer",
"description": "<p><strong>Required</strong>. External Group Id</p>",
"example": 1,
"name": "group_id",
"in": "body",
"rawType": "integer",
"rawDescription": "External Group Id",
"childParamsGroups": []
}
},
"required": [
"group_id"
]
},
"example": {
"group_id": 123
}
}
}
},
"x-github": {
"githubCloudOnly": true,
"enabledForGitHubApps": false,
"category": "teams",
"subcategory": "external-groups"
},
"slug": "update-the-connection-between-an-external-group-and-a-team",
"category": "teams",
"categoryLabel": "Teams",
"subcategory": "external-groups",
"subcategoryLabel": "External groups",
"contentType": "application/json",
"notes": [],
"descriptionHTML": "<p>Creates a connection between a team and an external group. Only one external group can be linked to a team.</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
"bodyParameters": [
{
"type": "integer",
"description": "<p><strong>Required</strong>. External Group Id</p>",
"example": 1,
"name": "group_id",
"in": "body",
"rawType": "integer",
"rawDescription": "External Group Id",
"childParamsGroups": []
}
],
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Response",
"payload": "<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"group_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"123\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"group_name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"Octocat admins\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"updated_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2021-01-24T11:31:04-06:00\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"teams\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span>\n <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"team_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"team_name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"team-test\"</span>\n <span class=\"hljs-punctuation\">}</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"team_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">2</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"team_name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"team-test2\"</span>\n <span class=\"hljs-punctuation\">}</span>\n <span class=\"hljs-punctuation\">]</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"members\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span>\n <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"member_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"member_login\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"mona-lisa_eocsaxrs\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"member_name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"Mona Lisa\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"member_email\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"mona_lisa@github.com\"</span>\n <span class=\"hljs-punctuation\">}</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"member_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">2</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"member_login\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"octo-lisa_eocsaxrs\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"member_name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"Octo Lisa\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"member_email\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"octo_lisa@github.com\"</span>\n <span class=\"hljs-punctuation\">}</span>\n <span class=\"hljs-punctuation\">]</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>"
}
]
},
{
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups",
"serverUrl": "https://{hostname}/api/v3",
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "team_slug",
"description": "team_slug parameter",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>team_slug parameter</p>"
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/external-groups",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/orgs/ORG/teams/TEAM_SLUG/external-groups</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/external-groups', {\n org: 'org',\n team_slug: 'team_slug'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'DELETE /orgs/{org}/teams/{team_slug}/external-groups'</span>, {\n <span class=\"hljs-attr\">org</span>: <span class=\"hljs-string\">'org'</span>,\n <span class=\"hljs-attr\">team_slug</span>: <span class=\"hljs-string\">'team_slug'</span>\n})\n</code></pre>"
}
],
"summary": "Remove the connection between an external group and a team",
"description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
"tags": [
"teams"
],
"operationId": "teams/unlink-external-idp-group-from-team-for-org",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/teams#unlink-external-idp-group-team-connection"
},
"x-github": {
"githubCloudOnly": true,
"enabledForGitHubApps": false,
"category": "teams",
"subcategory": "external-groups"
},
"slug": "remove-the-connection-between-an-external-group-and-a-team",
"category": "teams",
"categoryLabel": "Teams",
"subcategory": "external-groups",
"subcategoryLabel": "External groups",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"descriptionHTML": "<p>Deletes a connection between a team and an external group.</p>\n<p>You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>"
},
{
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/members",
@@ -29507,13 +29844,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":\"app_id\"}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'</code></pre>"
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":42}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection \\\n -d '{\"required_status_checks\":{\"strict\":true,\"contexts\":[\"contexts\"],\"checks\":[{\"context\":\"context\",\"app_id\":42}]},\"enforce_admins\":true,\"required_pull_request_reviews\":{\"dismissal_restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":42},\"restrictions\":{\"users\":[\"users\"],\"teams\":[\"teams\"],\"apps\":[\"apps\"]}}'</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 'app_id'\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/branches/{branch}/protection'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">required_status_checks</span>: {\n <span class=\"hljs-attr\">strict</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">contexts</span>: [\n <span class=\"hljs-string\">'contexts'</span>\n ],\n <span class=\"hljs-attr\">checks</span>: [\n {\n <span class=\"hljs-attr\">context</span>: <span class=\"hljs-string\">'context'</span>,\n <span class=\"hljs-attr\">app_id</span>: <span class=\"hljs-string\">'app_id'</span>\n }\n ]\n },\n <span class=\"hljs-attr\">enforce_admins</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_pull_request_reviews</span>: {\n <span class=\"hljs-attr\">dismissal_restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ]\n },\n <span class=\"hljs-attr\">dismiss_stale_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">require_code_owner_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_approving_review_count</span>: <span class=\"hljs-number\">42</span>\n },\n <span class=\"hljs-attr\">restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ],\n <span class=\"hljs-attr\">apps</span>: [\n <span class=\"hljs-string\">'apps'</span>\n ]\n }\n})\n</code></pre>"
"source": "await octokit.request('PUT /repos/{owner}/{repo}/branches/{branch}/protection', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: {\n strict: true,\n contexts: [\n 'contexts'\n ],\n checks: [\n {\n context: 'context',\n app_id: 42\n }\n ]\n },\n enforce_admins: true,\n required_pull_request_reviews: {\n dismissal_restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ]\n },\n dismiss_stale_reviews: true,\n require_code_owner_reviews: true,\n required_approving_review_count: 42\n },\n restrictions: {\n users: [\n 'users'\n ],\n teams: [\n 'teams'\n ],\n apps: [\n 'apps'\n ]\n }\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/branches/{branch}/protection'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">branch</span>: <span class=\"hljs-string\">'branch'</span>,\n <span class=\"hljs-attr\">required_status_checks</span>: {\n <span class=\"hljs-attr\">strict</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">contexts</span>: [\n <span class=\"hljs-string\">'contexts'</span>\n ],\n <span class=\"hljs-attr\">checks</span>: [\n {\n <span class=\"hljs-attr\">context</span>: <span class=\"hljs-string\">'context'</span>,\n <span class=\"hljs-attr\">app_id</span>: <span class=\"hljs-number\">42</span>\n }\n ]\n },\n <span class=\"hljs-attr\">enforce_admins</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_pull_request_reviews</span>: {\n <span class=\"hljs-attr\">dismissal_restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ]\n },\n <span class=\"hljs-attr\">dismiss_stale_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">require_code_owner_reviews</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">required_approving_review_count</span>: <span class=\"hljs-number\">42</span>\n },\n <span class=\"hljs-attr\">restrictions</span>: {\n <span class=\"hljs-attr\">users</span>: [\n <span class=\"hljs-string\">'users'</span>\n ],\n <span class=\"hljs-attr\">teams</span>: [\n <span class=\"hljs-string\">'teams'</span>\n ],\n <span class=\"hljs-attr\">apps</span>: [\n <span class=\"hljs-string\">'apps'</span>\n ]\n }\n})\n</code></pre>"
}
],
"summary": "Update branch protection",
@@ -29575,11 +29912,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -29605,11 +29942,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -29669,11 +30006,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -29699,11 +30036,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -29728,11 +30065,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -30249,11 +30586,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -30279,11 +30616,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -30343,11 +30680,11 @@
"childParamsGroups": []
},
"app_id": {
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -30373,11 +30710,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}
@@ -30402,11 +30739,11 @@
"childParamsGroups": []
},
{
"type": "string",
"type": "integer",
"description": "<p>The ID of the GitHub App that must provide this check. Set to <code>null</code> to accept the check from any source.</p>",
"name": "app_id",
"in": "body",
"rawType": "string",
"rawType": "integer",
"rawDescription": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source.",
"childParamsGroups": []
}

16
lib/rest/static/dereferenced/api.github.com.deref.json
View File

@@ -150453,7 +150453,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -151872,7 +151872,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -152782,7 +152782,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -153775,7 +153775,7 @@
"description": "The name of the required check"
},
"app_id": {
"type": "string",
"type": "integer",
"description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source."
}
}
@@ -153975,7 +153975,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -156584,7 +156584,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -156758,7 +156758,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -163025,7 +163025,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},

14
lib/rest/static/dereferenced/ghes-3.0.deref.json
View File

@@ -128538,7 +128538,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -129957,7 +129957,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -130867,7 +130867,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -131867,7 +131867,7 @@
"description": "The name of the required check"
},
"app_id": {
"type": "string",
"type": "integer",
"description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source."
}
}
@@ -132067,7 +132067,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -134718,7 +134718,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -134892,7 +134892,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}

16
lib/rest/static/dereferenced/ghes-3.1.deref.json
View File

@@ -128853,7 +128853,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -130272,7 +130272,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -131182,7 +131182,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -132182,7 +132182,7 @@
"description": "The name of the required check"
},
"app_id": {
"type": "string",
"type": "integer",
"description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source."
}
}
@@ -132382,7 +132382,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -135033,7 +135033,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -135207,7 +135207,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -141474,7 +141474,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},

16
lib/rest/static/dereferenced/ghes-3.2.deref.json
View File

@@ -132470,7 +132470,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -133889,7 +133889,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -134799,7 +134799,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -135799,7 +135799,7 @@
"description": "The name of the required check"
},
"app_id": {
"type": "string",
"type": "integer",
"description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source."
}
}
@@ -135999,7 +135999,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -138650,7 +138650,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -138824,7 +138824,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -145091,7 +145091,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},

16
lib/rest/static/dereferenced/ghes-3.3.deref.json
View File

@@ -139365,7 +139365,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -140784,7 +140784,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -141694,7 +141694,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -142687,7 +142687,7 @@
"description": "The name of the required check"
},
"app_id": {
"type": "string",
"type": "integer",
"description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source."
}
}
@@ -142887,7 +142887,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -145496,7 +145496,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -145670,7 +145670,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -151937,7 +151937,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},

599
lib/rest/static/dereferenced/github.ae.deref.json
View File

@@ -42277,6 +42277,335 @@
}
}
},
"/orgs/{org}/external-group/{group_id}": {
"get": {
"summary": "Get an external group",
"description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
"tags": [
"teams"
],
"operationId": "teams/external-idp-group-info-for-org",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/teams#external-idp-group-info-for-an-organization"
},
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "group_id",
"description": "group_id parameter",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"title": "ExternalGroup",
"description": "Information about an external group's usage and its members",
"type": "object",
"required": [
"group_id",
"group_name",
"teams",
"members"
],
"properties": {
"group_id": {
"description": "The internal ID of the group",
"example": 1,
"type": "integer"
},
"group_name": {
"description": "The display name for the group",
"example": "group-azuread-test",
"type": "string"
},
"updated_at": {
"description": "The date when the group was last updated_at",
"example": "2021-01-03 22:27:15:000 -700",
"type": "string"
},
"teams": {
"description": "An array of teams linked to this group",
"example": [
{
"team_id": 1,
"team_name": "team-test"
},
{
"team_id": 2,
"team_name": "team-test2"
}
],
"type": "array",
"items": {
"type": "object",
"required": [
"team_id",
"team_name"
],
"properties": {
"team_id": {
"description": "The id for a team",
"example": 1,
"type": "integer"
},
"team_name": {
"description": "The name of the team",
"example": "team-test",
"type": "string"
}
}
}
},
"members": {
"description": "An array of external members linked to this group",
"example": [
{
"member_id": 1,
"member_login": "mona-lisa_eocsaxrs",
"member_name": "Mona Lisa",
"member_email": "mona_lisa@github.com"
},
{
"member_id": 2,
"member_login": "octo-lisa_eocsaxrs",
"member_name": "Octo Lisa",
"member_email": "octo_lisa@github.com"
}
],
"type": "array",
"items": {
"type": "object",
"required": [
"member_id",
"member_login",
"member_name",
"member_email"
],
"properties": {
"member_id": {
"description": "The internal user ID of the identity",
"example": 1,
"type": "integer"
},
"member_login": {
"description": "The handle/login for the user",
"example": "mona-lisa_eocsaxrs",
"type": "string"
},
"member_name": {
"description": "The user display name/profile name",
"example": "Mona Lisa",
"type": "string"
},
"member_email": {
"description": "An email attached to a user",
"example": "mona_lisa@github.com",
"type": "string"
}
}
}
}
}
},
"examples": {
"default": {
"value": {
"group_id": "123",
"group_name": "Octocat admins",
"updated_at": "2021-01-24T11:31:04-06:00",
"teams": [
{
"team_id": 1,
"team_name": "team-test"
},
{
"team_id": 2,
"team_name": "team-test2"
}
],
"members": [
{
"member_id": 1,
"member_login": "mona-lisa_eocsaxrs",
"member_name": "Mona Lisa",
"member_email": "mona_lisa@github.com"
},
{
"member_id": 2,
"member_login": "octo-lisa_eocsaxrs",
"member_name": "Octo Lisa",
"member_email": "octo_lisa@github.com"
}
]
}
}
}
}
}
}
},
"x-github": {
"githubCloudOnly": true,
"enabledForGitHubApps": true,
"category": "teams",
"subcategory": "external-groups"
}
}
},
"/orgs/{org}/external-groups": {
"get": {
"summary": "List external groups in an organization",
"description": "Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub AE generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
"tags": [
"teams"
],
"operationId": "teams/list-external-idp-groups-for-org",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-external-idp-groups-for-an-organization"
},
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "per_page",
"description": "Results per page (max 100)",
"in": "query",
"schema": {
"type": "integer",
"default": 30
}
},
{
"name": "page",
"description": "Page token",
"in": "query",
"schema": {
"type": "integer"
}
},
{
"name": "display_name",
"description": "Limits the list to groups containing the text in the group name",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"title": "ExternalGroups",
"description": "A list of external groups available to be connected to a team",
"type": "object",
"properties": {
"groups": {
"description": "An array of external groups available to be mapped to a team",
"example": [
{
"group_id": 1,
"group_name": "group-azuread-test",
"updated_at": "2021-01-03 22:27:15:000 -700"
},
{
"group_id": 2,
"group_name": "group-azuread-test2",
"updated_at": "2021-06-03 22:27:15:000 -700"
}
],
"type": "array",
"items": {
"type": "object",
"required": [
"group_id",
"group_name",
"updated_at"
],
"properties": {
"group_id": {
"description": "The internal ID of the group",
"example": 1,
"type": "integer"
},
"group_name": {
"description": "The display name of the group",
"example": "group-azuread-test",
"type": "string"
},
"updated_at": {
"description": "The time of the last update for this group",
"example": "2019-06-03 22:27:15:000 -700",
"type": "string"
}
}
}
}
}
},
"examples": {
"default": {
"value": {
"groups": [
{
"group_id": "123",
"group_name": "Octocat admins",
"updated_at": "2021-01-24T11:31:04-06:00"
},
{
"group_id": "456",
"group_name": "Octocat docs members",
"updated_at": "2021-03-24T11:31:04-06:00"
}
]
}
}
}
}
},
"headers": {
"Link": {
"example": "<https://api.github.com/resource?per_page=2&page=url-encoded-next-page-token>; rel=\"next\"",
"schema": {
"type": "string"
}
}
}
}
},
"x-github": {
"githubCloudOnly": true,
"enabledForGitHubApps": true,
"category": "teams",
"subcategory": "external-groups"
}
}
},
"/orgs/{org}/hooks": {
"get": {
"summary": "List organization webhooks",
@@ -61634,6 +61963,262 @@
}
}
},
"/orgs/{org}/teams/{team_slug}/external-groups": {
"patch": {
"summary": "Update the connection between an external group and a team",
"description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.",
"tags": [
"teams"
],
"operationId": "teams/link-external-idp-group-to-team-for-org",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/teams#link-external-idp-group-team-connection"
},
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "team_slug",
"description": "team_slug parameter",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"group_id": {
"type": "integer",
"description": "External Group Id",
"example": 1
}
},
"required": [
"group_id"
]
},
"example": {
"group_id": 123
}
}
}
},
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"title": "ExternalGroup",
"description": "Information about an external group's usage and its members",
"type": "object",
"required": [
"group_id",
"group_name",
"teams",
"members"
],
"properties": {
"group_id": {
"description": "The internal ID of the group",
"example": 1,
"type": "integer"
},
"group_name": {
"description": "The display name for the group",
"example": "group-azuread-test",
"type": "string"
},
"updated_at": {
"description": "The date when the group was last updated_at",
"example": "2021-01-03 22:27:15:000 -700",
"type": "string"
},
"teams": {
"description": "An array of teams linked to this group",
"example": [
{
"team_id": 1,
"team_name": "team-test"
},
{
"team_id": 2,
"team_name": "team-test2"
}
],
"type": "array",
"items": {
"type": "object",
"required": [
"team_id",
"team_name"
],
"properties": {
"team_id": {
"description": "The id for a team",
"example": 1,
"type": "integer"
},
"team_name": {
"description": "The name of the team",
"example": "team-test",
"type": "string"
}
}
}
},
"members": {
"description": "An array of external members linked to this group",
"example": [
{
"member_id": 1,
"member_login": "mona-lisa_eocsaxrs",
"member_name": "Mona Lisa",
"member_email": "mona_lisa@github.com"
},
{
"member_id": 2,
"member_login": "octo-lisa_eocsaxrs",
"member_name": "Octo Lisa",
"member_email": "octo_lisa@github.com"
}
],
"type": "array",
"items": {
"type": "object",
"required": [
"member_id",
"member_login",
"member_name",
"member_email"
],
"properties": {
"member_id": {
"description": "The internal user ID of the identity",
"example": 1,
"type": "integer"
},
"member_login": {
"description": "The handle/login for the user",
"example": "mona-lisa_eocsaxrs",
"type": "string"
},
"member_name": {
"description": "The user display name/profile name",
"example": "Mona Lisa",
"type": "string"
},
"member_email": {
"description": "An email attached to a user",
"example": "mona_lisa@github.com",
"type": "string"
}
}
}
}
}
},
"examples": {
"default": {
"value": {
"group_id": "123",
"group_name": "Octocat admins",
"updated_at": "2021-01-24T11:31:04-06:00",
"teams": [
{
"team_id": 1,
"team_name": "team-test"
},
{
"team_id": 2,
"team_name": "team-test2"
}
],
"members": [
{
"member_id": 1,
"member_login": "mona-lisa_eocsaxrs",
"member_name": "Mona Lisa",
"member_email": "mona_lisa@github.com"
},
{
"member_id": 2,
"member_login": "octo-lisa_eocsaxrs",
"member_name": "Octo Lisa",
"member_email": "octo_lisa@github.com"
}
]
}
}
}
}
}
}
},
"x-github": {
"githubCloudOnly": true,
"enabledForGitHubApps": false,
"category": "teams",
"subcategory": "external-groups"
}
},
"delete": {
"summary": "Remove the connection between an external group and a team",
"description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
"tags": [
"teams"
],
"operationId": "teams/unlink-external-idp-group-from-team-for-org",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/teams#unlink-external-idp-group-team-connection"
},
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "team_slug",
"description": "team_slug parameter",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"x-github": {
"githubCloudOnly": true,
"enabledForGitHubApps": false,
"category": "teams",
"subcategory": "external-groups"
}
}
},
"/orgs/{org}/teams/{team_slug}/members": {
"get": {
"summary": "List team members",
@@ -103586,7 +104171,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -105005,7 +105590,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -105915,7 +106500,7 @@
"type": "string"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
},
@@ -106908,7 +107493,7 @@
"description": "The name of the required check"
},
"app_id": {
"type": "string",
"type": "integer",
"description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source."
}
}
@@ -107108,7 +107693,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -109717,7 +110302,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}
@@ -109891,7 +110476,7 @@
"example": "continuous-integration/travis-ci"
},
"app_id": {
"type": "string",
"type": "integer",
"nullable": true
}
}