Update OpenAPI Description (#43097)
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
This commit is contained in:
docs-bot
@@ -9898,7 +9898,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -14551,7 +14551,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -216558,7 +216558,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p> Purchases a GitHub Copilot for Business seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot for Business pricing, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business\">About billing for GitHub Copilot for Business</a>\".</p>\n<p> Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the <code>manage_billing:copilot</code> scope to use this endpoint.</p>\n<p> In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot for Business subscription, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization\">Setting up a Copilot for Business subscription for your organization</a>\".\nFor more information about setting a suggestion matching policy, see \"<a href=\"https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization\">Configuring suggestion matching policies for GitHub Copilot in your organization</a>\".</p>",
|
||||
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Purchases a GitHub Copilot for Business seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot for Business pricing, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business\">About billing for GitHub Copilot for Business</a>\".</p>\n<p>Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the <code>manage_billing:copilot</code> scope to use this endpoint.</p>\n<p>In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot for Business subscription, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization\">Setting up a Copilot for Business subscription for your organization</a>\".\nFor more information about setting a suggestion matching policy, see \"<a href=\"https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization\">Configuring suggestion matching policies for GitHub Copilot in your organization</a>\".</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -227438,7 +227438,7 @@
|
||||
"type": "boolean",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.</p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
}
|
||||
],
|
||||
"enabledForGitHubApps": true,
|
||||
@@ -254233,12 +254233,12 @@
|
||||
{
|
||||
"type": "string or null",
|
||||
"name": "sha",
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "content",
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -276416,7 +276416,7 @@
|
||||
"type": "string",
|
||||
"name": "lock_reason",
|
||||
"in": "body",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: </p>\n<ul>\n<li><code>off-topic</code> </li>\n<li><code>too heated</code> </li>\n<li><code>resolved</code> </li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:</p>\n<ul>\n<li><code>off-topic</code></li>\n<li><code>too heated</code></li>\n<li><code>resolved</code></li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"off-topic",
|
||||
"too heated",
|
||||
@@ -311454,7 +311454,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. </p>",
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -354160,7 +354160,7 @@
|
||||
"type": "string",
|
||||
"name": "role",
|
||||
"in": "body",
|
||||
"description": "<p>The role for the new member. </p>\n<ul>\n<li><code>admin</code> - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. </li>\n<li><code>direct_member</code> - Non-owner organization members with ability to see other members and join teams by invitation. </li>\n<li><code>billing_manager</code> - Non-owner organization members with ability to manage the billing settings of your organization.</li>\n</ul>",
|
||||
"description": "<p>The role for the new member.</p>\n<ul>\n<li><code>admin</code> - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.</li>\n<li><code>direct_member</code> - Non-owner organization members with ability to see other members and join teams by invitation.</li>\n<li><code>billing_manager</code> - Non-owner organization members with ability to manage the billing settings of your organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"admin",
|
||||
"direct_member",
|
||||
@@ -355725,7 +355725,7 @@
|
||||
"type": "string",
|
||||
"name": "role",
|
||||
"in": "body",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of: </p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization. </li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of:</p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization.</li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"admin",
|
||||
"member"
|
||||
@@ -356127,7 +356127,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>\n<p>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</p>\n</li>\n<li>\n<p>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</p>\n</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -444964,7 +444964,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example:</p>\n<p><code>application/zip</code></p>\n<p>GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>.</li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -466390,7 +466390,7 @@
|
||||
},
|
||||
{
|
||||
"name": "affiliation",
|
||||
"description": "<p>Comma-separated list of values. Can include: </p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user. </li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator. </li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"description": "<p>Comma-separated list of values. Can include:</p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user.</li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator.</li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
@@ -473698,7 +473698,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.</p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/rest/git/trees#get-a-tree\">recursively get the tree</a>.</li>\n<li>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</li>\n<li>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</li>\n<li>1 MB or smaller: All features of this endpoint are supported.</li>\n<li>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</li>\n<li>Greater than 100 MB: This endpoint is not supported.</li>\n</ul>\n<p>If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p>If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p>If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -488760,7 +488760,7 @@
|
||||
},
|
||||
{
|
||||
"name": "order",
|
||||
"description": "<p><strong>This field is deprecated.</strong> Determines whether the first search result returned is the highest number of matches (<code>desc</code>) or lowest number of matches (<code>asc</code>). This parameter is ignored unless you provide <code>sort</code>. </p>",
|
||||
"description": "<p><strong>This field is deprecated.</strong> Determines whether the first search result returned is the highest number of matches (<code>desc</code>) or lowest number of matches (<code>asc</code>). This parameter is ignored unless you provide <code>sort</code>.</p>",
|
||||
"in": "query",
|
||||
"deprecated": true,
|
||||
"required": false,
|
||||
@@ -518499,7 +518499,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -518509,7 +518509,7 @@
|
||||
"type": "string",
|
||||
"name": "notification_setting",
|
||||
"in": "body",
|
||||
"description": "<p>The notification setting the team has chosen. The options are: </p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned. </li>\n<li><code>notifications_disabled</code> - no one receives notifications.<br>\nDefault: <code>notifications_enabled</code></li>\n</ul>",
|
||||
"description": "<p>The notification setting the team has chosen. The options are:</p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>\n<li><code>notifications_disabled</code> - no one receives notifications.<br>\nDefault: <code>notifications_enabled</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"notifications_enabled",
|
||||
"notifications_disabled"
|
||||
@@ -520070,7 +520070,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -520080,7 +520080,7 @@
|
||||
"type": "string",
|
||||
"name": "notification_setting",
|
||||
"in": "body",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are: </p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned. </li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are:</p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"enum": [
|
||||
"notifications_enabled",
|
||||
"notifications_disabled"
|
||||
@@ -527460,7 +527460,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -527470,7 +527470,7 @@
|
||||
"type": "string",
|
||||
"name": "notification_setting",
|
||||
"in": "body",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are: </p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned. </li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are:</p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"enum": [
|
||||
"notifications_enabled",
|
||||
"notifications_disabled"
|
||||
|
||||
@@ -13730,7 +13730,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -17296,7 +17296,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -136411,7 +136411,7 @@
|
||||
"type": "boolean",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.</p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
}
|
||||
],
|
||||
"enabledForGitHubApps": true,
|
||||
@@ -168627,12 +168627,12 @@
|
||||
{
|
||||
"type": "string or null",
|
||||
"name": "sha",
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "content",
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -189498,7 +189498,7 @@
|
||||
"type": "string",
|
||||
"name": "lock_reason",
|
||||
"in": "body",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: </p>\n<ul>\n<li><code>off-topic</code> </li>\n<li><code>too heated</code> </li>\n<li><code>resolved</code> </li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:</p>\n<ul>\n<li><code>off-topic</code></li>\n<li><code>too heated</code></li>\n<li><code>resolved</code></li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"off-topic",
|
||||
"too heated",
|
||||
@@ -224111,7 +224111,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. </p>",
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -261152,7 +261152,7 @@
|
||||
"type": "string",
|
||||
"name": "role",
|
||||
"in": "body",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of: </p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization. </li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of:</p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization.</li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"admin",
|
||||
"member"
|
||||
@@ -261554,7 +261554,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/github-ae@latest/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>\n<p>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/github-ae@latest/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</p>\n</li>\n<li>\n<p>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</p>\n</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -325242,7 +325242,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub AE expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub AE renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/github-ae@latest/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub AE Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example:</p>\n<p><code>application/zip</code></p>\n<p>GitHub AE expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub AE renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/github-ae@latest/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub AE Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>.</li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -344014,7 +344014,7 @@
|
||||
},
|
||||
{
|
||||
"name": "affiliation",
|
||||
"description": "<p>Comma-separated list of values. Can include: </p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user. </li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator. </li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"description": "<p>Comma-separated list of values. Can include:</p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user.</li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator.</li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
@@ -351125,7 +351125,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. </p>\n</li>\n<li>\n<p>This API supports files up to 1 megabyte in size.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.</p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree\">recursively get the tree</a>.</li>\n<li>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</li>\n<li>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.</li>\n<li>This API supports files up to 1 megabyte in size.</li>\n</ul>\n<p>If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p>If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p>If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -359732,7 +359732,7 @@
|
||||
},
|
||||
{
|
||||
"name": "order",
|
||||
"description": "<p><strong>This field is deprecated.</strong> Determines whether the first search result returned is the highest number of matches (<code>desc</code>) or lowest number of matches (<code>asc</code>). This parameter is ignored unless you provide <code>sort</code>. </p>",
|
||||
"description": "<p><strong>This field is deprecated.</strong> Determines whether the first search result returned is the highest number of matches (<code>desc</code>) or lowest number of matches (<code>asc</code>). This parameter is ignored unless you provide <code>sort</code>.</p>",
|
||||
"in": "query",
|
||||
"deprecated": true,
|
||||
"required": false,
|
||||
@@ -370323,7 +370323,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -370333,7 +370333,7 @@
|
||||
"type": "string",
|
||||
"name": "notification_setting",
|
||||
"in": "body",
|
||||
"description": "<p>The notification setting the team has chosen. The options are: </p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned. </li>\n<li><code>notifications_disabled</code> - no one receives notifications.<br>\nDefault: <code>notifications_enabled</code></li>\n</ul>",
|
||||
"description": "<p>The notification setting the team has chosen. The options are:</p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>\n<li><code>notifications_disabled</code> - no one receives notifications.<br>\nDefault: <code>notifications_enabled</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"notifications_enabled",
|
||||
"notifications_disabled"
|
||||
@@ -371894,7 +371894,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -371904,7 +371904,7 @@
|
||||
"type": "string",
|
||||
"name": "notification_setting",
|
||||
"in": "body",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are: </p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned. </li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are:</p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"enum": [
|
||||
"notifications_enabled",
|
||||
"notifications_disabled"
|
||||
@@ -379199,7 +379199,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -379209,7 +379209,7 @@
|
||||
"type": "string",
|
||||
"name": "notification_setting",
|
||||
"in": "body",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are: </p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned. </li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are:</p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"enum": [
|
||||
"notifications_enabled",
|
||||
"notifications_disabled"
|
||||
|
||||
@@ -19522,7 +19522,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -24175,7 +24175,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -228267,7 +228267,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p> Purchases a GitHub Copilot for Business seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot for Business pricing, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business\">About billing for GitHub Copilot for Business</a>\".</p>\n<p> Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the <code>manage_billing:copilot</code> scope to use this endpoint.</p>\n<p> In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot for Business subscription, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization\">Setting up a Copilot for Business subscription for your organization</a>\".\nFor more information about setting a suggestion matching policy, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization\">Configuring suggestion matching policies for GitHub Copilot in your organization</a>\".</p>",
|
||||
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Purchases a GitHub Copilot for Business seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot for Business pricing, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business\">About billing for GitHub Copilot for Business</a>\".</p>\n<p>Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the <code>manage_billing:copilot</code> scope to use this endpoint.</p>\n<p>In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot for Business subscription, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization\">Setting up a Copilot for Business subscription for your organization</a>\".\nFor more information about setting a suggestion matching policy, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization\">Configuring suggestion matching policies for GitHub Copilot in your organization</a>\".</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -239147,7 +239147,7 @@
|
||||
"type": "boolean",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.</p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
}
|
||||
],
|
||||
"enabledForGitHubApps": true,
|
||||
@@ -273044,12 +273044,12 @@
|
||||
{
|
||||
"type": "string or null",
|
||||
"name": "sha",
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "content",
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -295227,7 +295227,7 @@
|
||||
"type": "string",
|
||||
"name": "lock_reason",
|
||||
"in": "body",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: </p>\n<ul>\n<li><code>off-topic</code> </li>\n<li><code>too heated</code> </li>\n<li><code>resolved</code> </li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:</p>\n<ul>\n<li><code>off-topic</code></li>\n<li><code>too heated</code></li>\n<li><code>resolved</code></li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"off-topic",
|
||||
"too heated",
|
||||
@@ -330265,7 +330265,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. </p>",
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -376456,7 +376456,7 @@
|
||||
"type": "string",
|
||||
"name": "role",
|
||||
"in": "body",
|
||||
"description": "<p>The role for the new member. </p>\n<ul>\n<li><code>admin</code> - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. </li>\n<li><code>direct_member</code> - Non-owner organization members with ability to see other members and join teams by invitation. </li>\n<li><code>billing_manager</code> - Non-owner organization members with ability to manage the billing settings of your organization.</li>\n</ul>",
|
||||
"description": "<p>The role for the new member.</p>\n<ul>\n<li><code>admin</code> - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.</li>\n<li><code>direct_member</code> - Non-owner organization members with ability to see other members and join teams by invitation.</li>\n<li><code>billing_manager</code> - Non-owner organization members with ability to manage the billing settings of your organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"admin",
|
||||
"direct_member",
|
||||
@@ -378021,7 +378021,7 @@
|
||||
"type": "string",
|
||||
"name": "role",
|
||||
"in": "body",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of: </p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization. </li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of:</p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization.</li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"admin",
|
||||
"member"
|
||||
@@ -378423,7 +378423,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>\n<p>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</p>\n</li>\n<li>\n<p>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</p>\n</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -467266,7 +467266,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Cloud Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example:</p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Cloud Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>.</li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -488693,7 +488693,7 @@
|
||||
},
|
||||
{
|
||||
"name": "affiliation",
|
||||
"description": "<p>Comma-separated list of values. Can include: </p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user. </li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator. </li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"description": "<p>Comma-separated list of values. Can include:</p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user.</li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator.</li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
@@ -496001,7 +496001,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.</p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree\">recursively get the tree</a>.</li>\n<li>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</li>\n<li>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</li>\n<li>1 MB or smaller: All features of this endpoint are supported.</li>\n<li>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</li>\n<li>Greater than 100 MB: This endpoint is not supported.</li>\n</ul>\n<p>If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p>If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p>If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -513670,7 +513670,7 @@
|
||||
},
|
||||
{
|
||||
"name": "order",
|
||||
"description": "<p><strong>This field is deprecated.</strong> Determines whether the first search result returned is the highest number of matches (<code>desc</code>) or lowest number of matches (<code>asc</code>). This parameter is ignored unless you provide <code>sort</code>. </p>",
|
||||
"description": "<p><strong>This field is deprecated.</strong> Determines whether the first search result returned is the highest number of matches (<code>desc</code>) or lowest number of matches (<code>asc</code>). This parameter is ignored unless you provide <code>sort</code>.</p>",
|
||||
"in": "query",
|
||||
"deprecated": true,
|
||||
"required": false,
|
||||
@@ -543409,7 +543409,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -543419,7 +543419,7 @@
|
||||
"type": "string",
|
||||
"name": "notification_setting",
|
||||
"in": "body",
|
||||
"description": "<p>The notification setting the team has chosen. The options are: </p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned. </li>\n<li><code>notifications_disabled</code> - no one receives notifications.<br>\nDefault: <code>notifications_enabled</code></li>\n</ul>",
|
||||
"description": "<p>The notification setting the team has chosen. The options are:</p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>\n<li><code>notifications_disabled</code> - no one receives notifications.<br>\nDefault: <code>notifications_enabled</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"notifications_enabled",
|
||||
"notifications_disabled"
|
||||
@@ -544980,7 +544980,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -544990,7 +544990,7 @@
|
||||
"type": "string",
|
||||
"name": "notification_setting",
|
||||
"in": "body",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are: </p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned. </li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are:</p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"enum": [
|
||||
"notifications_enabled",
|
||||
"notifications_disabled"
|
||||
@@ -552370,7 +552370,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -552380,7 +552380,7 @@
|
||||
"type": "string",
|
||||
"name": "notification_setting",
|
||||
"in": "body",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are: </p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned. </li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are:</p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"enum": [
|
||||
"notifications_enabled",
|
||||
"notifications_disabled"
|
||||
|
||||
@@ -19735,7 +19735,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -24390,7 +24390,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -189427,7 +189427,7 @@
|
||||
"type": "boolean",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.10/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.</p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.10/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
}
|
||||
],
|
||||
"enabledForGitHubApps": true,
|
||||
@@ -210298,7 +210298,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The SCIM API endpoints for enterprise accounts are currently in <em>private</em> beta and are subject to change.</p>\n<p> Deletes a SCIM group from an enterprise.</p>",
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The SCIM API endpoints for enterprise accounts are currently in <em>private</em> beta and are subject to change.</p>\n<p>Deletes a SCIM group from an enterprise.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
@@ -233102,12 +233102,12 @@
|
||||
{
|
||||
"type": "string or null",
|
||||
"name": "sha",
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "content",
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -254483,7 +254483,7 @@
|
||||
"type": "string",
|
||||
"name": "lock_reason",
|
||||
"in": "body",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: </p>\n<ul>\n<li><code>off-topic</code> </li>\n<li><code>too heated</code> </li>\n<li><code>resolved</code> </li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:</p>\n<ul>\n<li><code>off-topic</code></li>\n<li><code>too heated</code></li>\n<li><code>resolved</code></li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"off-topic",
|
||||
"too heated",
|
||||
@@ -289521,7 +289521,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. </p>",
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -336691,7 +336691,7 @@
|
||||
"type": "string",
|
||||
"name": "role",
|
||||
"in": "body",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of: </p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization. </li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of:</p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization.</li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"admin",
|
||||
"member"
|
||||
@@ -337093,7 +337093,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>\n<p>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</p>\n</li>\n<li>\n<p>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</p>\n</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -420298,7 +420298,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example:</p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>.</li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -441236,7 +441236,7 @@
|
||||
},
|
||||
{
|
||||
"name": "affiliation",
|
||||
"description": "<p>Comma-separated list of values. Can include: </p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user. </li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator. </li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"description": "<p>Comma-separated list of values. Can include:</p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user.</li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator.</li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
@@ -448544,7 +448544,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.10/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.</p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree\">recursively get the tree</a>.</li>\n<li>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</li>\n<li>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</li>\n<li>1 MB or smaller: All features of this endpoint are supported.</li>\n<li>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.10/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</li>\n<li>Greater than 100 MB: This endpoint is not supported.</li>\n</ul>\n<p>If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p>If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p>If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -470477,7 +470477,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -470487,7 +470487,7 @@
|
||||
"type": "string",
|
||||
"name": "notification_setting",
|
||||
"in": "body",
|
||||
"description": "<p>The notification setting the team has chosen. The options are: </p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned. </li>\n<li><code>notifications_disabled</code> - no one receives notifications.<br>\nDefault: <code>notifications_enabled</code></li>\n</ul>",
|
||||
"description": "<p>The notification setting the team has chosen. The options are:</p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>\n<li><code>notifications_disabled</code> - no one receives notifications.<br>\nDefault: <code>notifications_enabled</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"notifications_enabled",
|
||||
"notifications_disabled"
|
||||
@@ -472038,7 +472038,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -472048,7 +472048,7 @@
|
||||
"type": "string",
|
||||
"name": "notification_setting",
|
||||
"in": "body",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are: </p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned. </li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are:</p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"enum": [
|
||||
"notifications_enabled",
|
||||
"notifications_disabled"
|
||||
@@ -479404,7 +479404,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -479414,7 +479414,7 @@
|
||||
"type": "string",
|
||||
"name": "notification_setting",
|
||||
"in": "body",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are: </p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned. </li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"description": "<p>The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are:</p>\n<ul>\n<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>\n<li><code>notifications_disabled</code> - no one receives notifications.</li>\n</ul>",
|
||||
"enum": [
|
||||
"notifications_enabled",
|
||||
"notifications_disabled"
|
||||
|
||||
@@ -18227,7 +18227,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -22634,7 +22634,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -173372,7 +173372,7 @@
|
||||
"type": "boolean",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.6/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.</p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.6/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
}
|
||||
],
|
||||
"enabledForGitHubApps": true,
|
||||
@@ -192326,7 +192326,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The SCIM API endpoints for enterprise accounts are currently in <em>private</em> beta and are subject to change.</p>\n<p> Deletes a SCIM group from an enterprise.</p>",
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The SCIM API endpoints for enterprise accounts are currently in <em>private</em> beta and are subject to change.</p>\n<p>Deletes a SCIM group from an enterprise.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
@@ -215062,12 +215062,12 @@
|
||||
{
|
||||
"type": "string or null",
|
||||
"name": "sha",
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "content",
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -236395,7 +236395,7 @@
|
||||
"type": "string",
|
||||
"name": "lock_reason",
|
||||
"in": "body",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: </p>\n<ul>\n<li><code>off-topic</code> </li>\n<li><code>too heated</code> </li>\n<li><code>resolved</code> </li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:</p>\n<ul>\n<li><code>off-topic</code></li>\n<li><code>too heated</code></li>\n<li><code>resolved</code></li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"off-topic",
|
||||
"too heated",
|
||||
@@ -271353,7 +271353,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. </p>",
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -316162,7 +316162,7 @@
|
||||
"type": "string",
|
||||
"name": "role",
|
||||
"in": "body",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of: </p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization. </li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of:</p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization.</li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"admin",
|
||||
"member"
|
||||
@@ -316564,7 +316564,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.6/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>\n<p>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.6/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</p>\n</li>\n<li>\n<p>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</p>\n</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -382456,7 +382456,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example:</p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>.</li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -402786,7 +402786,7 @@
|
||||
},
|
||||
{
|
||||
"name": "affiliation",
|
||||
"description": "<p>Comma-separated list of values. Can include: </p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user. </li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator. </li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"description": "<p>Comma-separated list of values. Can include:</p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user.</li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator.</li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
@@ -409979,7 +409979,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.6/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.6/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.</p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.6/rest/git/trees#get-a-tree\">recursively get the tree</a>.</li>\n<li>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</li>\n<li>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</li>\n<li>1 MB or smaller: All features of this endpoint are supported.</li>\n<li>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.6/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</li>\n<li>Greater than 100 MB: This endpoint is not supported.</li>\n</ul>\n<p>If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p>If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p>If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -431511,7 +431511,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -433023,7 +433023,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -440228,7 +440228,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
|
||||
@@ -19023,7 +19023,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -23446,7 +23446,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -176150,7 +176150,7 @@
|
||||
"type": "boolean",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.7/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.</p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.7/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
}
|
||||
],
|
||||
"enabledForGitHubApps": true,
|
||||
@@ -195132,7 +195132,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The SCIM API endpoints for enterprise accounts are currently in <em>private</em> beta and are subject to change.</p>\n<p> Deletes a SCIM group from an enterprise.</p>",
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The SCIM API endpoints for enterprise accounts are currently in <em>private</em> beta and are subject to change.</p>\n<p>Deletes a SCIM group from an enterprise.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
@@ -217888,12 +217888,12 @@
|
||||
{
|
||||
"type": "string or null",
|
||||
"name": "sha",
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "content",
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -239269,7 +239269,7 @@
|
||||
"type": "string",
|
||||
"name": "lock_reason",
|
||||
"in": "body",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: </p>\n<ul>\n<li><code>off-topic</code> </li>\n<li><code>too heated</code> </li>\n<li><code>resolved</code> </li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:</p>\n<ul>\n<li><code>off-topic</code></li>\n<li><code>too heated</code></li>\n<li><code>resolved</code></li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"off-topic",
|
||||
"too heated",
|
||||
@@ -274267,7 +274267,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. </p>",
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -319343,7 +319343,7 @@
|
||||
"type": "string",
|
||||
"name": "role",
|
||||
"in": "body",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of: </p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization. </li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of:</p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization.</li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"admin",
|
||||
"member"
|
||||
@@ -319745,7 +319745,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.7/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>\n<p>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.7/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</p>\n</li>\n<li>\n<p>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</p>\n</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -386115,7 +386115,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example:</p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>.</li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -406554,7 +406554,7 @@
|
||||
},
|
||||
{
|
||||
"name": "affiliation",
|
||||
"description": "<p>Comma-separated list of values. Can include: </p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user. </li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator. </li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"description": "<p>Comma-separated list of values. Can include:</p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user.</li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator.</li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
@@ -413793,7 +413793,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.7/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.</p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/trees#get-a-tree\">recursively get the tree</a>.</li>\n<li>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</li>\n<li>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</li>\n<li>1 MB or smaller: All features of this endpoint are supported.</li>\n<li>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.7/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</li>\n<li>Greater than 100 MB: This endpoint is not supported.</li>\n</ul>\n<p>If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p>If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p>If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -435423,7 +435423,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -436935,7 +436935,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -444151,7 +444151,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
|
||||
@@ -19044,7 +19044,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -23467,7 +23467,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -185936,7 +185936,7 @@
|
||||
"type": "boolean",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.8/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.</p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.8/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
}
|
||||
],
|
||||
"enabledForGitHubApps": true,
|
||||
@@ -205146,7 +205146,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The SCIM API endpoints for enterprise accounts are currently in <em>private</em> beta and are subject to change.</p>\n<p> Deletes a SCIM group from an enterprise.</p>",
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The SCIM API endpoints for enterprise accounts are currently in <em>private</em> beta and are subject to change.</p>\n<p>Deletes a SCIM group from an enterprise.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
@@ -227926,12 +227926,12 @@
|
||||
{
|
||||
"type": "string or null",
|
||||
"name": "sha",
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "content",
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -249307,7 +249307,7 @@
|
||||
"type": "string",
|
||||
"name": "lock_reason",
|
||||
"in": "body",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: </p>\n<ul>\n<li><code>off-topic</code> </li>\n<li><code>too heated</code> </li>\n<li><code>resolved</code> </li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:</p>\n<ul>\n<li><code>off-topic</code></li>\n<li><code>too heated</code></li>\n<li><code>resolved</code></li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"off-topic",
|
||||
"too heated",
|
||||
@@ -284305,7 +284305,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. </p>",
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -329503,7 +329503,7 @@
|
||||
"type": "string",
|
||||
"name": "role",
|
||||
"in": "body",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of: </p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization. </li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of:</p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization.</li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"admin",
|
||||
"member"
|
||||
@@ -329905,7 +329905,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.8/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>\n<p>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.8/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</p>\n</li>\n<li>\n<p>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</p>\n</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -396305,7 +396305,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example:</p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>.</li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -416761,7 +416761,7 @@
|
||||
},
|
||||
{
|
||||
"name": "affiliation",
|
||||
"description": "<p>Comma-separated list of values. Can include: </p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user. </li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator. </li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"description": "<p>Comma-separated list of values. Can include:</p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user.</li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator.</li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
@@ -424000,7 +424000,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.8/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.</p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/trees#get-a-tree\">recursively get the tree</a>.</li>\n<li>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</li>\n<li>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</li>\n<li>1 MB or smaller: All features of this endpoint are supported.</li>\n<li>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.8/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</li>\n<li>Greater than 100 MB: This endpoint is not supported.</li>\n</ul>\n<p>If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p>If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p>If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -445734,7 +445734,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -447246,7 +447246,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -454462,7 +454462,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
|
||||
@@ -19263,7 +19263,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -23686,7 +23686,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token: </p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token\nexpires after one hour.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint.\nIf the repository is private, you must use an access token with the <code>repo</code> scope.\nGitHub Apps must have the <code>administration</code> permission for repositories and the <code>organization_self_hosted_runners</code> permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the <code>manage_runners:enterprise</code> scope for enterprises, to use these endpoints.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided\nby this endpoint.</p>\n<p><code>config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN</code></p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -188077,7 +188077,7 @@
|
||||
"type": "boolean",
|
||||
"name": "read_only",
|
||||
"in": "body",
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. </p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.9/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
"description": "<p>If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.</p>\n<p>Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/articles/repository-permission-levels-for-an-organization/\">Repository permission levels for an organization</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.9/articles/permission-levels-for-a-user-account-repository/\">Permission levels for a user account repository</a>.\"</p>"
|
||||
}
|
||||
],
|
||||
"enabledForGitHubApps": true,
|
||||
@@ -207767,7 +207767,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The SCIM API endpoints for enterprise accounts are currently in <em>private</em> beta and are subject to change.</p>\n<p> Deletes a SCIM group from an enterprise.</p>",
|
||||
"descriptionHTML": "<p><strong>Note:</strong> The SCIM API endpoints for enterprise accounts are currently in <em>private</em> beta and are subject to change.</p>\n<p>Deletes a SCIM group from an enterprise.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
@@ -230571,12 +230571,12 @@
|
||||
{
|
||||
"type": "string or null",
|
||||
"name": "sha",
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The SHA1 checksum ID of the object in the tree. Also called <code>tree.sha</code>. If the value is <code>null</code> then the file will be deleted.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "content",
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>. </p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
"description": "<p>The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or <code>tree.sha</code>.</p>\n<p><strong>Note:</strong> Use either <code>tree.sha</code> or <code>content</code> to specify the contents of the entry. Using both <code>tree.sha</code> and <code>content</code> will return an error.</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -251952,7 +251952,7 @@
|
||||
"type": "string",
|
||||
"name": "lock_reason",
|
||||
"in": "body",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: </p>\n<ul>\n<li><code>off-topic</code> </li>\n<li><code>too heated</code> </li>\n<li><code>resolved</code> </li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"description": "<p>The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:</p>\n<ul>\n<li><code>off-topic</code></li>\n<li><code>too heated</code></li>\n<li><code>resolved</code></li>\n<li><code>spam</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"off-topic",
|
||||
"too heated",
|
||||
@@ -286950,7 +286950,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. </p>",
|
||||
"descriptionHTML": "<p>Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -334072,7 +334072,7 @@
|
||||
"type": "string",
|
||||
"name": "role",
|
||||
"in": "body",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of: </p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization. </li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"description": "<p>The role to give the user in the organization. Can be one of:</p>\n<ul>\n<li><code>admin</code> - The user will become an owner of the organization.</li>\n<li><code>member</code> - The user will become a non-owner member of the organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"admin",
|
||||
"member"
|
||||
@@ -334474,7 +334474,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>\n<p>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</p>\n</li>\n<li>\n<p>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</p>\n</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -414164,7 +414164,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example:</p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>.</li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
@@ -434932,7 +434932,7 @@
|
||||
},
|
||||
{
|
||||
"name": "affiliation",
|
||||
"description": "<p>Comma-separated list of values. Can include: </p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user. </li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator. </li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"description": "<p>Comma-separated list of values. Can include:</p>\n<ul>\n<li><code>owner</code>: Repositories that are owned by the authenticated user.</li>\n<li><code>collaborator</code>: Repositories that the user has been added to as a collaborator.</li>\n<li><code>organization_member</code>: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.</li>\n</ul>",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
@@ -442226,7 +442226,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.9/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.</p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree\">recursively get the tree</a>.</li>\n<li>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</li>\n<li>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</li>\n<li>1 MB or smaller: All features of this endpoint are supported.</li>\n<li>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.9/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</li>\n<li>Greater than 100 MB: This endpoint is not supported.</li>\n</ul>\n<p>If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p>If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p>If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -464092,7 +464092,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault: <code>secret</code><br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.<br>\nDefault for child team: <code>closed</code></li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -465604,7 +465604,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
@@ -472875,7 +472875,7 @@
|
||||
"type": "string",
|
||||
"name": "privacy",
|
||||
"in": "body",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong> </p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team. </li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong> </li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"description": "<p>The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. The options are:<br>\n<strong>For a non-nested team:</strong></p>\n<ul>\n<li><code>secret</code> - only visible to organization owners and members of this team.</li>\n<li><code>closed</code> - visible to all members of this organization.<br>\n<strong>For a parent or child team:</strong></li>\n<li><code>closed</code> - visible to all members of this organization.</li>\n</ul>",
|
||||
"enum": [
|
||||
"secret",
|
||||
"closed"
|
||||
|
||||
Reference in New Issue
Block a user