Skip to content

Commit 77f4d3f

Browse files
Update OpenAPI Descriptions (github#26779)
1 parent ea9a577 commit 77f4d3f

13 files changed

+4717
-46
lines changed

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2549,6 +2549,21 @@
25492549
"verb": "get",
25502550
"requestPath": "/repos/{owner}/{repo}/tags"
25512551
},
2552+
{
2553+
"slug": "list-tag-protection-states-for-a-repository",
2554+
"verb": "get",
2555+
"requestPath": "/repos/{owner}/{repo}/tags/protection"
2556+
},
2557+
{
2558+
"slug": "create-a-tag-protection-state-for-a-repository",
2559+
"verb": "post",
2560+
"requestPath": "/repos/{owner}/{repo}/tags/protection"
2561+
},
2562+
{
2563+
"slug": "delete-a-tag-protection-state-for-a-repository",
2564+
"verb": "delete",
2565+
"requestPath": "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}"
2566+
},
25522567
{
25532568
"slug": "download-a-repository-archive-tar",
25542569
"verb": "get",

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

Lines changed: 263 additions & 3 deletions
Large diffs are not rendered by default.

lib/rest/static/decorated/ghes-3.1.json

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26518,7 +26518,7 @@
2651826518
"description": "<p>Validation failed</p>"
2651926519
}
2652026520
],
26521-
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/[email protected]/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/[email protected]/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
26521+
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/[email protected]/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/[email protected]/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/[email protected]/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/[email protected]/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
2652226522
"bodyParameters": [
2652326523
{
2652426524
"type": "string",
@@ -34939,10 +34939,16 @@
3493934939
"notes": [],
3494034940
"descriptionHTML": "",
3494134941
"responses": [
34942+
{
34943+
"httpStatusCode": "200",
34944+
"httpStatusMessage": "OK",
34945+
"description": "<p>Response when getting an existing impersonation OAuth token</p>",
34946+
"payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\n \"token_last_eight\": \"Ae178B4a\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"fingerprint\": \"jklmnop12345678\"\n}"
34947+
},
3494234948
{
3494334949
"httpStatusCode": "201",
3494434950
"httpStatusMessage": "Created",
34945-
"description": "<p>Response</p>",
34951+
"description": "<p>Response when creating a new impersonation OAuth token</p>",
3494634952
"payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\n \"token_last_eight\": \"Ae178B4a\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"fingerprint\": \"jklmnop12345678\"\n}"
3494734953
}
3494834954
],
@@ -48074,7 +48080,7 @@
4807448080
"subcategory": "outside-collaborators",
4807548081
"notes": [],
4807648082
"bodyParameters": [],
48077-
"descriptionHTML": "<p>When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"<a href=\"https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/\">Converting an organization member to an outside collaborator</a>\".</p>",
48083+
"descriptionHTML": "<p>When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"<a href=\"https://docs.github.com/[email protected]/articles/converting-an-organization-member-to-an-outside-collaborator/\">Converting an organization member to an outside collaborator</a>\".</p>",
4807848084
"responses": [
4807948085
{
4808048086
"httpStatusCode": "202",
@@ -48089,7 +48095,7 @@
4808948095
{
4809048096
"httpStatusCode": "403",
4809148097
"httpStatusMessage": "Forbidden",
48092-
"description": "<p>Forbidden if user is the last owner of the organization or not a member of the organization</p>"
48098+
"description": "<p>Forbidden if user is the last owner of the organization or not a member of the organization.</p>"
4809348099
},
4809448100
{
4809548101
"httpStatusCode": "404",

lib/rest/static/decorated/ghes-3.2.json

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27384,7 +27384,7 @@
2738427384
"description": "<p>Validation failed</p>"
2738527385
}
2738627386
],
27387-
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/[email protected]/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/[email protected]/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
27387+
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/[email protected]/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/[email protected]/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/[email protected]/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/[email protected]/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
2738827388
"bodyParameters": [
2738927389
{
2739027390
"type": "string",
@@ -36258,10 +36258,16 @@
3625836258
"notes": [],
3625936259
"descriptionHTML": "",
3626036260
"responses": [
36261+
{
36262+
"httpStatusCode": "200",
36263+
"httpStatusMessage": "OK",
36264+
"description": "<p>Response when getting an existing impersonation OAuth token</p>",
36265+
"payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\n \"token_last_eight\": \"Ae178B4a\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"expires_at\": \"2011-10-06T17:26:27Z\",\n \"fingerprint\": \"jklmnop12345678\"\n}"
36266+
},
3626136267
{
3626236268
"httpStatusCode": "201",
3626336269
"httpStatusMessage": "Created",
36264-
"description": "<p>Response</p>",
36270+
"description": "<p>Response when creating a new impersonation OAuth token</p>",
3626536271
"payload": "{\n \"id\": 1,\n \"url\": \"https://api.github.com/authorizations/1\",\n \"scopes\": [\n \"public_repo\"\n ],\n \"token\": \"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\n \"token_last_eight\": \"Ae178B4a\",\n \"hashed_token\": \"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\n \"app\": {\n \"url\": \"http://my-github-app.com\",\n \"name\": \"my github app\",\n \"client_id\": \"abcde12345fghij67890\"\n },\n \"note\": \"optional note\",\n \"note_url\": \"http://optional/note/url\",\n \"updated_at\": \"2011-09-06T20:39:23Z\",\n \"created_at\": \"2011-09-06T17:26:27Z\",\n \"expires_at\": \"2011-10-06T17:26:27Z\",\n \"fingerprint\": \"jklmnop12345678\"\n}"
3626636272
}
3626736273
],
@@ -49393,7 +49399,7 @@
4939349399
"subcategory": "outside-collaborators",
4939449400
"notes": [],
4939549401
"bodyParameters": [],
49396-
"descriptionHTML": "<p>When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"<a href=\"https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/\">Converting an organization member to an outside collaborator</a>\".</p>",
49402+
"descriptionHTML": "<p>When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"<a href=\"https://docs.github.com/[email protected]/articles/converting-an-organization-member-to-an-outside-collaborator/\">Converting an organization member to an outside collaborator</a>\".</p>",
4939749403
"responses": [
4939849404
{
4939949405
"httpStatusCode": "202",
@@ -49408,7 +49414,7 @@
4940849414
{
4940949415
"httpStatusCode": "403",
4941049416
"httpStatusMessage": "Forbidden",
49411-
"description": "<p>Forbidden if user is the last owner of the organization or not a member of the organization</p>"
49417+
"description": "<p>Forbidden if user is the last owner of the organization or not a member of the organization.</p>"
4941249418
},
4941349419
{
4941449420
"httpStatusCode": "404",

0 commit comments

Comments
 (0)