The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Give read-only permission, and allow approving PRs.
", + "example": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.\nGitHub Apps must have the enterprise_administration:write permission to use this endpoint.
Success response
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions/workflow", + "title": "Set default workflow permissions for an enterprise", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "enterprise", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
" + } + ], + "bodyParameters": [ + { + "type": "string", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
", + "enum": [ + "read", + "write" + ], + "name": "default_workflow_permissions", + "in": "body", + "rawType": "string", + "rawDescription": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
", + "name": "can_approve_pull_request_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.", + "childParamsGroups": [] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Give read-only permission, and allow approving PRs.", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + }, + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "204", + "description": "Success response
" + } + } + ], + "previews": [], + "descriptionHTML": "Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.\nGitHub Apps must have the enterprise_administration:write permission to use this endpoint.
Success response
" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -1877,7 +2000,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Response
", + "description": "Give read-only permission, and allow approving PRs.
", "example": { "default_workflow_permissions": "read", "can_approve_pull_request_reviews": true @@ -1886,7 +2009,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well if GitHub Actions can submit approving pull request reviews.
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Whether GitHub Actions can submit approving pull request reviews.
", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
", "name": "can_approve_pull_request_reviews", "in": "body", "rawType": "boolean", - "rawDescription": "Whether GitHub Actions can submit approving pull request reviews.", + "rawDescription": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.", "childParamsGroups": [] } ], @@ -1942,7 +2065,7 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Give read-only permission, and allow approving PRs.", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "default_workflow_permissions": "read", @@ -1954,16 +2077,20 @@ }, "response": { "statusCode": "204", - "description": "Response
" + "description": "Success response
" } } ], "previews": [], - "descriptionHTML": "Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews.
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"
You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
No Content
" + "description": "Success response
" + }, + { + "httpStatusCode": "409", + "description": "Conflict response when changing a setting is prevented by the owning enterprise
" } ] }, @@ -2403,6 +2530,153 @@ "description": "No Content
" } ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", + "title": "Get default workflow permissions for a repository", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Give read-only permission, and allow approving PRs.
", + "example": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the repository administration permission to use this API.
OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow", + "title": "Set default workflow permissions for a repository", + "category": "actions", + "subcategory": "permissions", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "bodyParameters": [ + { + "type": "string", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
", + "enum": [ + "read", + "write" + ], + "name": "default_workflow_permissions", + "in": "body", + "rawType": "string", + "rawDescription": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
", + "name": "can_approve_pull_request_reviews", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.", + "childParamsGroups": [] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Give read-only permission, and allow approving PRs.", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "204", + "description": "Success response
" + } + } + ], + "previews": [], + "descriptionHTML": "Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"
You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the repository administration permission to use this API.
Success response
" + }, + { + "httpStatusCode": "409", + "description": "Conflict response when changing a setting is prevented by the owning organization or enterprise
" + } + ] } ], "secrets": [ @@ -32139,6 +32413,29 @@ }, "descriptionHTML": "" }, + { + "name": "tool_name", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "descriptionHTML": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.
The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.
Set to open, closed, fixed, or dismissed` to list code scanning alerts in a specific state.
Set to open, closed, fixed, or dismissed to list code scanning alerts in a specific state.
Validation failed
" } ], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" }, { "serverUrl": "https://api.github.com", @@ -90352,13 +90649,13 @@ "bodyParameters": [ { "type": "string", - "description": "Required. A custom webhook event name.
", + "description": "Required. A custom webhook event name. Must be 100 characters or fewer.
", "minLength": 1, "maxLength": 100, "name": "event_type", "in": "body", "rawType": "string", - "rawDescription": "A custom webhook event name.", + "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.", "childParamsGroups": [] }, { diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 28feafbe5f..58f447a516 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -28343,7 +28343,7 @@ "description": "Validation failed
" } ], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -71075,13 +71075,13 @@ "bodyParameters": [ { "type": "string", - "description": "Required. A custom webhook event name.
", + "description": "Required. A custom webhook event name. Must be 100 characters or fewer.
", "minLength": 1, "maxLength": 100, "name": "event_type", "in": "body", "rawType": "string", - "rawDescription": "A custom webhook event name.", + "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.", "childParamsGroups": [] }, { diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 4fabf529a7..3cee399d77 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -29411,7 +29411,7 @@ "description": "Validation failed
" } ], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -73867,13 +73867,13 @@ "bodyParameters": [ { "type": "string", - "description": "Required. A custom webhook event name.
", + "description": "Required. A custom webhook event name. Must be 100 characters or fewer.
", "minLength": 1, "maxLength": 100, "name": "event_type", "in": "body", "rawType": "string", - "rawDescription": "A custom webhook event name.", + "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.", "childParamsGroups": [] }, { diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index dddda7f4a8..c8b90b10f1 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -29566,7 +29566,7 @@ "description": "Validation failed
" } ], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -73808,13 +73808,13 @@ "bodyParameters": [ { "type": "string", - "description": "Required. A custom webhook event name.
", + "description": "Required. A custom webhook event name. Must be 100 characters or fewer.
", "minLength": 1, "maxLength": 100, "name": "event_type", "in": "body", "rawType": "string", - "rawDescription": "A custom webhook event name.", + "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.", "childParamsGroups": [] }, { diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index 09d7e87c99..a83fa82791 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -31002,7 +31002,7 @@ "description": "Validation failed
" } ], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -78125,13 +78125,13 @@ "bodyParameters": [ { "type": "string", - "description": "Required. A custom webhook event name.
", + "description": "Required. A custom webhook event name. Must be 100 characters or fewer.
", "minLength": 1, "maxLength": 100, "name": "event_type", "in": "body", "rawType": "string", - "rawDescription": "A custom webhook event name.", + "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.", "childParamsGroups": [] }, { diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 06015fa141..fd2013d94c 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -26866,7 +26866,7 @@ "description": "Validation failed
" } ], - "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nRate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
\nCannot assign {member} permission of {role name}\nNote that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the repository invitations API endpoints.
\nUpdating an existing collaborator's permission level
\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.
Rate limits
\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
" }, { "serverUrl": "https://HOSTNAME/api/v3", @@ -68699,13 +68699,13 @@ "bodyParameters": [ { "type": "string", - "description": "Required. A custom webhook event name.
", + "description": "Required. A custom webhook event name. Must be 100 characters or fewer.
", "minLength": 1, "maxLength": 100, "name": "event_type", "in": "body", "rawType": "string", - "rawDescription": "A custom webhook event name.", + "rawDescription": "A custom webhook event name. Must be 100 characters or fewer.", "childParamsGroups": [] }, {