Skip to content

Commit 98daee0

Browse files
Update OpenAPI Descriptions
1 parent 21e276d commit 98daee0

File tree

3 files changed

+175
-177
lines changed

3 files changed

+175
-177
lines changed

lib/rest/static/apps/enabled-for-apps.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2670,11 +2670,6 @@
26702670
}
26712671
],
26722672
"teams": [
2673-
{
2674-
"slug": "list-a-connection-between-an-external-group-and-a-team",
2675-
"verb": "get",
2676-
"requestPath": "/organizations/{org}/team/{team_slug}/external-groups"
2677-
},
26782673
{
26792674
"slug": "get-an-external-group",
26802675
"verb": "get",
@@ -2765,6 +2760,11 @@
27652760
"verb": "delete",
27662761
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
27672762
},
2763+
{
2764+
"slug": "list-a-connection-between-an-external-group-and-a-team",
2765+
"verb": "get",
2766+
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
2767+
},
27682768
{
27692769
"slug": "list-pending-team-invitations",
27702770
"verb": "get",

lib/rest/static/decorated/api.github.com.json

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -85696,7 +85696,7 @@
8569685696
"external-groups": [
8569785697
{
8569885698
"verb": "get",
85699-
"requestPath": "/organizations/{org}/team/{team_slug}/external-groups",
85699+
"requestPath": "/orgs/{org}/external-group/{group_id}",
8570085700
"parameters": [
8570185701
{
8570285702
"name": "org",
@@ -85708,50 +85708,50 @@
8570885708
"descriptionHTML": ""
8570985709
},
8571085710
{
85711-
"name": "team_slug",
85712-
"description": "team_slug parameter",
85711+
"name": "group_id",
85712+
"description": "group_id parameter",
8571385713
"in": "path",
8571485714
"required": true,
8571585715
"schema": {
85716-
"type": "string"
85716+
"type": "integer"
8571785717
},
85718-
"descriptionHTML": "<p>team_slug parameter</p>"
85718+
"descriptionHTML": "<p>group_id parameter</p>"
8571985719
}
8572085720
],
8572185721
"x-codeSamples": [
8572285722
{
8572385723
"lang": "Shell",
85724-
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations/ORG/team/TEAM_SLUG/external-groups"
85724+
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/external-group/42"
8572585725
},
8572685726
{
8572785727
"lang": "JavaScript",
85728-
"source": "await octokit.request('GET /organizations/{org}/team/{team_slug}/external-groups', {\n org: 'org',\n team_slug: 'team_slug'\n})"
85728+
"source": "await octokit.request('GET /orgs/{org}/external-group/{group_id}', {\n org: 'org',\n group_id: 42\n})"
8572985729
}
8573085730
],
85731-
"summary": "List a connection between an external group and a team",
85731+
"summary": "Get an external group",
8573285732
"x-github": {
8573385733
"enabledForGitHubApps": true,
8573485734
"category": "teams",
8573585735
"subcategory": "external-groups"
8573685736
},
85737-
"slug": "list-a-connection-between-an-external-group-and-a-team",
85737+
"slug": "get-an-external-group",
8573885738
"category": "teams",
8573985739
"subcategory": "external-groups",
8574085740
"notes": [],
8574185741
"bodyParameters": [],
85742-
"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>",
85742+
"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/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
8574385743
"responses": [
8574485744
{
8574585745
"httpStatusCode": "200",
8574685746
"httpStatusMessage": "OK",
8574785747
"description": "<p>Response</p>",
85748-
"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}"
85748+
"payload": "{\n \"group_id\": \"123\",\n \"group_name\": \"Octocat admins\",\n \"updated_at\": \"2021-01-24T11:31:04-06:00\",\n \"teams\": [\n {\n \"team_id\": 1,\n \"team_name\": \"team-test\"\n },\n {\n \"team_id\": 2,\n \"team_name\": \"team-test2\"\n }\n ],\n \"members\": [\n {\n \"member_id\": 1,\n \"member_login\": \"mona-lisa_eocsaxrs\",\n \"member_name\": \"Mona Lisa\",\n \"member_email\": \"[email protected]\"\n },\n {\n \"member_id\": 2,\n \"member_login\": \"octo-lisa_eocsaxrs\",\n \"member_name\": \"Octo Lisa\",\n \"member_email\": \"[email protected]\"\n }\n ]\n}"
8574985749
}
8575085750
]
8575185751
},
8575285752
{
8575385753
"verb": "get",
85754-
"requestPath": "/orgs/{org}/external-group/{group_id}",
85754+
"requestPath": "/orgs/{org}/external-groups",
8575585755
"parameters": [
8575685756
{
8575785757
"name": "org",
@@ -85763,50 +85763,68 @@
8576385763
"descriptionHTML": ""
8576485764
},
8576585765
{
85766-
"name": "group_id",
85767-
"description": "group_id parameter",
85768-
"in": "path",
85769-
"required": true,
85766+
"name": "per_page",
85767+
"description": "Results per page (max 100)",
85768+
"in": "query",
85769+
"schema": {
85770+
"type": "integer",
85771+
"default": 30
85772+
},
85773+
"descriptionHTML": "<p>Results per page (max 100)</p>"
85774+
},
85775+
{
85776+
"name": "page",
85777+
"description": "Page token",
85778+
"in": "query",
8577085779
"schema": {
8577185780
"type": "integer"
8577285781
},
85773-
"descriptionHTML": "<p>group_id parameter</p>"
85782+
"descriptionHTML": "<p>Page token</p>"
85783+
},
85784+
{
85785+
"name": "display_name",
85786+
"description": "Limits the list to groups containing the text in the group name",
85787+
"in": "query",
85788+
"schema": {
85789+
"type": "string"
85790+
},
85791+
"descriptionHTML": "<p>Limits the list to groups containing the text in the group name</p>"
8577485792
}
8577585793
],
8577685794
"x-codeSamples": [
8577785795
{
8577885796
"lang": "Shell",
85779-
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/external-group/42"
85797+
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/external-groups"
8578085798
},
8578185799
{
8578285800
"lang": "JavaScript",
85783-
"source": "await octokit.request('GET /orgs/{org}/external-group/{group_id}', {\n org: 'org',\n group_id: 42\n})"
85801+
"source": "await octokit.request('GET /orgs/{org}/external-groups', {\n org: 'org'\n})"
8578485802
}
8578585803
],
85786-
"summary": "Get an external group",
85804+
"summary": "List external groups in an organization",
8578785805
"x-github": {
8578885806
"enabledForGitHubApps": true,
8578985807
"category": "teams",
8579085808
"subcategory": "external-groups"
8579185809
},
85792-
"slug": "get-an-external-group",
85810+
"slug": "list-external-groups-in-an-organization",
8579385811
"category": "teams",
8579485812
"subcategory": "external-groups",
8579585813
"notes": [],
8579685814
"bodyParameters": [],
85797-
"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/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
85815+
"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 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/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
8579885816
"responses": [
8579985817
{
8580085818
"httpStatusCode": "200",
8580185819
"httpStatusMessage": "OK",
8580285820
"description": "<p>Response</p>",
85803-
"payload": "{\n \"group_id\": \"123\",\n \"group_name\": \"Octocat admins\",\n \"updated_at\": \"2021-01-24T11:31:04-06:00\",\n \"teams\": [\n {\n \"team_id\": 1,\n \"team_name\": \"team-test\"\n },\n {\n \"team_id\": 2,\n \"team_name\": \"team-test2\"\n }\n ],\n \"members\": [\n {\n \"member_id\": 1,\n \"member_login\": \"mona-lisa_eocsaxrs\",\n \"member_name\": \"Mona Lisa\",\n \"member_email\": \"[email protected]\"\n },\n {\n \"member_id\": 2,\n \"member_login\": \"octo-lisa_eocsaxrs\",\n \"member_name\": \"Octo Lisa\",\n \"member_email\": \"[email protected]\"\n }\n ]\n}"
85821+
"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}"
8580485822
}
8580585823
]
8580685824
},
8580785825
{
8580885826
"verb": "get",
85809-
"requestPath": "/orgs/{org}/external-groups",
85827+
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups",
8581085828
"parameters": [
8581185829
{
8581285830
"name": "org",
@@ -85818,56 +85836,38 @@
8581885836
"descriptionHTML": ""
8581985837
},
8582085838
{
85821-
"name": "per_page",
85822-
"description": "Results per page (max 100)",
85823-
"in": "query",
85824-
"schema": {
85825-
"type": "integer",
85826-
"default": 30
85827-
},
85828-
"descriptionHTML": "<p>Results per page (max 100)</p>"
85829-
},
85830-
{
85831-
"name": "page",
85832-
"description": "Page token",
85833-
"in": "query",
85834-
"schema": {
85835-
"type": "integer"
85836-
},
85837-
"descriptionHTML": "<p>Page token</p>"
85838-
},
85839-
{
85840-
"name": "display_name",
85841-
"description": "Limits the list to groups containing the text in the group name",
85842-
"in": "query",
85839+
"name": "team_slug",
85840+
"description": "team_slug parameter",
85841+
"in": "path",
85842+
"required": true,
8584385843
"schema": {
8584485844
"type": "string"
8584585845
},
85846-
"descriptionHTML": "<p>Limits the list to groups containing the text in the group name</p>"
85846+
"descriptionHTML": "<p>team_slug parameter</p>"
8584785847
}
8584885848
],
8584985849
"x-codeSamples": [
8585085850
{
8585185851
"lang": "Shell",
85852-
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/external-groups"
85852+
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/external-groups"
8585385853
},
8585485854
{
8585585855
"lang": "JavaScript",
85856-
"source": "await octokit.request('GET /orgs/{org}/external-groups', {\n org: 'org'\n})"
85856+
"source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/external-groups', {\n org: 'org',\n team_slug: 'team_slug'\n})"
8585785857
}
8585885858
],
85859-
"summary": "List external groups in an organization",
85859+
"summary": "List a connection between an external group and a team",
8586085860
"x-github": {
8586185861
"enabledForGitHubApps": true,
8586285862
"category": "teams",
8586385863
"subcategory": "external-groups"
8586485864
},
85865-
"slug": "list-external-groups-in-an-organization",
85865+
"slug": "list-a-connection-between-an-external-group-and-a-team",
8586685866
"category": "teams",
8586785867
"subcategory": "external-groups",
8586885868
"notes": [],
8586985869
"bodyParameters": [],
85870-
"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 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/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
85870+
"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>",
8587185871
"responses": [
8587285872
{
8587385873
"httpStatusCode": "200",

0 commit comments

Comments
 (0)