Skip to content

repo sync #17955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 18, 2022
Merged

repo sync #17955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebe5a69
Update OpenAPI Descriptions (#27778)
github-openapi-bot May 18, 2022
1273c93
Merge branch 'main' into repo-sync
Octomerger May 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/rest/enterprise-admin/audit-log.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ versions:
fpt: '*'
ghes: '>=3.3'
ghec: '*'
ghae: '*'
topics:
- API
miniTocMaxHeadingLevel: 3
Expand Down
6 changes: 6 additions & 0 deletions lib/rest/static/apps/enabled-for-apps.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21181,6 +21181,12 @@
"verb": "patch",
"requestPath": "/orgs/{org}"
},
{
"slug": "get-the-audit-log-for-an-organization",
"subcategory": "orgs",
"verb": "get",
"requestPath": "/orgs/{org}/audit-log"
},
{
"slug": "list-organization-webhooks",
"subcategory": "webhooks",
Expand Down
132 changes: 117 additions & 15 deletions lib/rest/static/decorated/api.github.com.json
View file
Open in desktop

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions lib/rest/static/decorated/ghes-3.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153966,7 +153966,7 @@
}
}
],
"descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/[email protected]/rest/reference/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>\n<p>If you pass the <code>hellcat-preview</code> media type, you can also update the LDAP mapping of a child team.</p>",
"descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise[email protected]/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/[email protected]/rest/reference/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>\n<p>If you pass the <code>hellcat-preview</code> media type, you can also update the LDAP mapping of a child team.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
Expand Down Expand Up @@ -159837,11 +159837,11 @@
},
{
"type": "string",
"description": "<p><strong>Required for built-in authentication.</strong> The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the <a href=\"https://docs.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/\">GitHub authentication guide</a>.</p>",
"description": "<p><strong>Required for built-in authentication.</strong> The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise[email protected]/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise\">About authentication for your enterprise</a>.\"</p>",
"name": "email",
"in": "body",
"rawType": "string",
"rawDescription": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://docs.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).",
"rawDescription": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise[email protected]/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"",
"isRequired": false,
"childParamsGroups": []
}
Expand Down Expand Up @@ -161956,11 +161956,11 @@
"bodyParameters": [
{
"type": "string",
"description": "<p>The reason the user is being suspended. This message will be logged in the <a href=\"https://docs.github.com/enterprise/admin/articles/audit-logging/\">audit log</a>. If you don't provide a <code>reason</code>, it will default to \"Suspended via API by <em>SITE_ADMINISTRATOR</em>\", where <em>SITE_ADMINISTRATOR</em> is the person who performed the action.</p>",
"description": "<p>The reason the user is being suspended. This message will be logged in the <a href=\"https://docs.github.com/enterprise[email protected]/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise\">audit log</a>. If you don't provide a <code>reason</code>, it will default to \"Suspended via API by <em>SITE_ADMINISTRATOR</em>\", where <em>SITE_ADMINISTRATOR</em> is the person who performed the action.</p>",
"name": "reason",
"in": "body",
"rawType": "string",
"rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
"rawDescription": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise[email protected]/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
"isRequired": false,
"childParamsGroups": []
}
Expand All @@ -161984,7 +161984,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If your GitHub instance uses <a href=\"https://docs.github.com/enterprise/admin/guides/user-management/using-ldap\">LDAP Sync with Active Directory LDAP servers</a>, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a <code>403</code> response.</p>\n<p>You can suspend any user account except your own.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"descriptionHTML": "<p>If your GitHub instance uses <a href=\"https://docs.github.com/enterprise[email protected]/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap\">LDAP Sync with Active Directory LDAP servers</a>, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a <code>403</code> response.</p>\n<p>You can suspend any user account except your own.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
Expand Down Expand Up @@ -162013,11 +162013,11 @@
"bodyParameters": [
{
"type": "string",
"description": "<p>The reason the user is being unsuspended. This message will be logged in the <a href=\"https://docs.github.com/enterprise/admin/articles/audit-logging/\">audit log</a>. If you don't provide a <code>reason</code>, it will default to \"Unsuspended via API by <em>SITE_ADMINISTRATOR</em>\", where <em>SITE_ADMINISTRATOR</em> is the person who performed the action.</p>",
"description": "<p>The reason the user is being unsuspended. This message will be logged in the <a href=\"https://docs.github.com/enterprise[email protected]/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise\">audit log</a>. If you don't provide a <code>reason</code>, it will default to \"Unsuspended via API by <em>SITE_ADMINISTRATOR</em>\", where <em>SITE_ADMINISTRATOR</em> is the person who performed the action.</p>",
"name": "reason",
"in": "body",
"rawType": "string",
"rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
"rawDescription": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise[email protected]/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
"isRequired": false,
"childParamsGroups": []
}
Expand All @@ -162041,7 +162041,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If your GitHub instance uses <a href=\"https://docs.github.com/enterprise/admin/guides/user-management/using-ldap\">LDAP Sync with Active Directory LDAP servers</a>, this API is disabled and will return a <code>403</code> response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.</p>",
"descriptionHTML": "<p>If your GitHub instance uses <a href=\"https://docs.github.com/enterprise[email protected]/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap\">LDAP Sync with Active Directory LDAP servers</a>, this API is disabled and will return a <code>403</code> response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
Expand Down Expand Up @@ -362393,7 +362393,7 @@
{
"name": "secret_type",
"in": "query",
"description": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/[email protected]/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>",
"description": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/[email protected]/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types.</p>",
"required": false,
"schema": {
"type": "string"
Expand Down
Loading