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

Update OpenAPI Descriptions

Browse Source
This commit is contained in:
github-openapi-bot
2022-03-22 05:23:02 -07:00
committed by GitHub
parent 21e276df2f
commit 98daee0533
3 changed files with 178 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -85694,61 +85694,6 @@
}
],
"external-groups": [
{
"verb": "get",
"requestPath": "/organizations/{org}/team/{team_slug}/external-groups",
"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 -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations/ORG/team/TEAM_SLUG/external-groups"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /organizations/{org}/team/{team_slug}/external-groups', {\n org: 'org',\n team_slug: 'team_slug'\n})"
}
],
"summary": "List a connection between an external group and a team",
"x-github": {
"enabledForGitHubApps": true,
"category": "teams",
"subcategory": "external-groups"
},
"slug": "list-a-connection-between-an-external-group-and-a-team",
"category": "teams",
"subcategory": "external-groups",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists a connection between a team and an external group.</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/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "<p>Response</p>",
"payload": "{\n \"groups\": [\n {\n \"group_id\": \"123\",\n \"group_name\": \"Octocat admins\",\n \"updated_at\": \"2021-01-24T11:31:04-06:00\"\n },\n {\n \"group_id\": \"456\",\n \"group_name\": \"Octocat docs members\",\n \"updated_at\": \"2021-03-24T11:31:04-06:00\"\n }\n ]\n}"
}
]
},
{
"verb": "get",
"requestPath": "/orgs/{org}/external-group/{group_id}",
@@ -85877,6 +85822,61 @@
}
]
},
{
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups",
"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 -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/external-groups"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/external-groups', {\n org: 'org',\n team_slug: 'team_slug'\n})"
}
],
"summary": "List a connection between an external group and a team",
"x-github": {
"enabledForGitHubApps": true,
"category": "teams",
"subcategory": "external-groups"
},
"slug": "list-a-connection-between-an-external-group-and-a-team",
"category": "teams",
"subcategory": "external-groups",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists a connection between a team and an external group.</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/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "<p>Response</p>",
"payload": "{\n \"groups\": [\n {\n \"group_id\": \"123\",\n \"group_name\": \"Octocat admins\",\n \"updated_at\": \"2021-01-24T11:31:04-06:00\"\n },\n {\n \"group_id\": \"456\",\n \"group_name\": \"Octocat docs members\",\n \"updated_at\": \"2021-03-24T11:31:04-06:00\"\n }\n ]\n}"
}
]
},
{
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups",