1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Update OpenAPI Description (#57877)

Co-authored-by: Steve Ward <steveward@github.com>
This commit is contained in:
docs-bot
2025-10-08 12:47:53 -07:00
committed by GitHub
parent fbb1897fd6
commit ec06337bc7
2 changed files with 209 additions and 209 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -6066,13 +6066,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -13269,13 +13269,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -27065,13 +27065,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deletes a repository variable using the variable name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Deletes a repository variable using the variable name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -82297,13 +82297,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: <a href=\"https://github.com/notifications\">https://github.com/notifications</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No content</p>"
}
]
],
"descriptionHTML": "<p>Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: <a href=\"https://github.com/notifications\">https://github.com/notifications</a>.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -89941,13 +89941,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-server@3.16/rest/activity/watching#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-server@3.16/rest/activity/watching#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -92338,13 +92338,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes the announcement banner currently set for the organization.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Removes the announcement banner currently set for the organization.</p>"
}
]
},
@@ -101610,13 +101610,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.16/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.16/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -123986,7 +123986,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -123996,7 +123995,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
]
],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -197996,13 +197996,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -198112,13 +198112,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a single organization secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets a single organization secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -221644,13 +221644,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
]
],
"descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -224933,7 +224933,6 @@
}
],
"previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.</p>\n</div>\n<p>Replaces an existing provisioned groups information.</p>\n<p>You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the <a href=\"#update-an-attribute-for-a-scim-enterprise-group\">Update an attribute for a SCIM enterprise group</a> endpoint instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -224967,7 +224966,8 @@
"httpStatusCode": "500",
"description": "<p>Internal server error</p>"
}
]
],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.</p>\n</div>\n<p>Replaces an existing provisioned groups information.</p>\n<p>You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the <a href=\"#update-an-attribute-for-a-scim-enterprise-group\">Update an attribute for a SCIM enterprise group</a> endpoint instead.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -329480,7 +329480,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Each array contains the day number, hour number, and number of commits:</p>\n<ul>\n<li><code>0-6</code>: Sunday - Saturday</li>\n<li><code>0-23</code>: Hour of day</li>\n<li>Number of commits</li>\n</ul>\n<p>For example, <code>[2, 14, 25]</code> indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -329490,7 +329489,8 @@
"httpStatusCode": "204",
"description": "<p>A header with no content is returned.</p>"
}
]
],
"descriptionHTML": "<p>Each array contains the day number, hour number, and number of commits:</p>\n<ul>\n<li><code>0-6</code>: Sunday - Saturday</li>\n<li><code>0-23</code>: Hour of day</li>\n<li>Number of commits</li>\n</ul>\n<p>For example, <code>[2, 14, 25]</code> indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.</p>"
}
]
},
@@ -338153,7 +338153,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Initiates the generation of a user migration archive.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -338175,7 +338174,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
]
],
"descriptionHTML": "<p>Initiates the generation of a user migration archive.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -373448,13 +373448,13 @@
}
],
"previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/orgs/organization-roles\">Organization Roles</a>\" endpoints instead.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/orgs/organization-roles\">Organization Roles</a>\" endpoints instead.</p>\n</div>"
}
],
"webhooks": [
@@ -398974,7 +398974,6 @@
}
],
"previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the <a href=\"https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/\">changelog</a> for more information.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -398984,7 +398983,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
]
],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the <a href=\"https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/\">changelog</a> for more information.</p>\n</div>"
}
]
},
@@ -419827,7 +419827,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -419837,7 +419836,8 @@
"httpStatusCode": "404",
"description": "<p>Not Found if pull request has not been merged</p>"
}
]
],
"descriptionHTML": "<p>Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -439114,13 +439114,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -443095,13 +443095,13 @@
}
],
"previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.16/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.16/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -448535,7 +448535,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the <a href=\"https://docs.github.com/enterprise-server@3.16/rest/repos/repos#list-repository-tags\">Repository Tags API</a>.</p>\n<p>Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -448545,7 +448544,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
]
],
"descriptionHTML": "<p>This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the <a href=\"https://docs.github.com/enterprise-server@3.16/rest/repos/repos#list-repository-tags\">Repository Tags API</a>.</p>\n<p>Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -480143,7 +480143,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists repositories that the authenticated user has explicit permission (<code>:read</code>, <code>:write</code>, or <code>:admin</code>) to access.</p>\n<p>The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -480165,7 +480164,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
]
],
"descriptionHTML": "<p>Lists repositories that the authenticated user has explicit permission (<code>:read</code>, <code>:write</code>, or <code>:admin</code>) to access.</p>\n<p>The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -505619,7 +505619,6 @@
}
],
"previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> This operation is closing down and will be removed after August 30, 2024. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/repos/rules#create-a-repository-ruleset\">Repository Rulesets</a>\" endpoint instead.</p>\n</div>\n<p>This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -505633,7 +505632,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
]
],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> This operation is closing down and will be removed after August 30, 2024. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/repos/rules#create-a-repository-ruleset\">Repository Rulesets</a>\" endpoint instead.</p>\n</div>\n<p>This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -520754,7 +520754,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a single secret scanning alert detected in an eligible repository.</p>\n<p>The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>security_events</code> scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the <code>public_repo</code> scope instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -520772,7 +520771,8 @@
"httpStatusCode": "503",
"description": "<p>Service unavailable</p>"
}
]
],
"descriptionHTML": "<p>Gets a single secret scanning alert detected in an eligible repository.</p>\n<p>The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>security_events</code> scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the <code>public_repo</code> scope instead.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -531680,13 +531680,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the child teams of the team specified by <code>{team_slug}</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/teams</code>.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>if child teams exist</p>"
}
]
],
"descriptionHTML": "<p>Lists the child teams of the team specified by <code>{team_slug}</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/teams</code>.</p>\n</div>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -534165,7 +534165,6 @@
}
],
"previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/teams#delete-a-team\">Delete a team</a> endpoint.</p>\n</div>\n<p>To delete a team, the authenticated user must be an organization owner or team maintainer.</p>\n<p>If you are an organization owner, deleting a parent team will delete all of its child teams as well.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -534179,7 +534178,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
]
],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/teams#delete-a-team\">Delete a team</a> endpoint.</p>\n</div>\n<p>To delete a team, the authenticated user must be an organization owner or team maintainer.</p>\n<p>If you are an organization owner, deleting a parent team will delete all of its child teams as well.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -545412,13 +545412,13 @@
}
],
"previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#create-a-discussion\"><code>Create a discussion</code></a> endpoint.</p>\n</div>\n<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.16/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
]
],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#create-a-discussion\"><code>Create a discussion</code></a> endpoint.</p>\n</div>\n<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.16/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -546441,13 +546441,13 @@
}
],
"previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#delete-a-discussion\"><code>Delete a discussion</code></a> endpoint.</p>\n</div>\n<p>Delete a discussion from a team's page.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#delete-a-discussion\"><code>Delete a discussion</code></a> endpoint.</p>\n</div>\n<p>Delete a discussion from a team's page.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
}
],
"external-groups": [
@@ -554039,7 +554039,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists your publicly visible email address, which you can set with the\n<a href=\"https://docs.github.com/enterprise-server@3.16/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user\">Set primary email visibility for the authenticated user</a>\nendpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>user:email</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -554061,7 +554060,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
]
],
"descriptionHTML": "<p>Lists your publicly visible email address, which you can set with the\n<a href=\"https://docs.github.com/enterprise-server@3.16/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user\">Set primary email visibility for the authenticated user</a>\nendpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>user:email</code> scope to use this endpoint.</p>"
}
],
"followers": [
@@ -554643,7 +554643,6 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -554665,7 +554664,8 @@
"httpStatusCode": "404",
"description": "<p>if the person is not followed by the authenticated user</p>"
}
]
],
"descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -555331,13 +555331,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the people who the specified user follows.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists the people who the specified user follows.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",