docs: octokit.interactions.{getRestrictionsForYourPublicRepos,removeRestrictionsForYourPublicRepos,setRestrictionsForYourPublicRepos}

gr2m · gr2m · commit d3c0e0af401e · 2020-11-30T23:31:15.000-08:00
diff --git a/docs/codeScanning/listAlertsForRepo.md b/docs/codeScanning/listAlertsForRepo.md
@@ -8,7 +8,7 @@ type: API method
 
 # List code scanning alerts for a repository
 
-Lists all open code scanning alerts for the default branch (usually `master`) and protected branches in a repository. For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. GitHub Apps must have the `security_events` read permission to use this endpoint.
+Lists all open code scanning alerts for the default branch (usually `main` or `master`). For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. GitHub Apps must have the `security_events` read permission to use this endpoint.
 
 ```js
 octokit.codeScanning.listAlertsForRepo({
diff --git a/docs/interactions/getRestrictionsForOrg.md b/docs/interactions/getRestrictionsForOrg.md
@@ -8,7 +8,7 @@ type: API method
 
 # Get interaction restrictions for an organization
 
-Shows which group of GitHub users can interact with this organization and when the restriction expires. If there are no restrictions, you will see an empty response.
+Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
 
 ```js
 octokit.interactions.getRestrictionsForOrg({
diff --git a/docs/interactions/getRestrictionsForRepo.md b/docs/interactions/getRestrictionsForRepo.md
@@ -8,7 +8,7 @@ type: API method
 
 # Get interaction restrictions for a repository
 
-Shows which group of GitHub users can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.
+Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.
 
 ```js
 octokit.interactions.getRestrictionsForRepo({
diff --git a/docs/interactions/getRestrictionsForYourPublicRepos.md b/docs/interactions/getRestrictionsForYourPublicRepos.md
@@ -0,0 +1,21 @@
+---
+name: Get interaction restrictions for your public repositories
+example: octokit.interactions.getRestrictionsForYourPublicRepos()
+route: GET /user/interaction-limits
+scope: interactions
+type: API method
+---
+
+# Get interaction restrictions for your public repositories
+
+Shows which type of GitHub user can interact with your public repositories and when the restriction expires. If there are no restrictions, you will see an empty response.
+
+```js
+octokit.interactions.getRestrictionsForYourPublicRepos();
+```
+
+## Parameters
+
+This endpoint has no parameters
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories).
diff --git a/docs/interactions/removeRestrictionsForRepo.md b/docs/interactions/removeRestrictionsForRepo.md
@@ -8,7 +8,7 @@ type: API method
 
 # Remove interaction restrictions for a repository
 
-Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions.
+Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.
 
 ```js
 octokit.interactions.removeRestrictionsForRepo({
diff --git a/docs/interactions/removeRestrictionsForYourPublicRepos.md b/docs/interactions/removeRestrictionsForYourPublicRepos.md
@@ -0,0 +1,21 @@
+---
+name: Remove interaction restrictions from your public repositories
+example: octokit.interactions.removeRestrictionsForYourPublicRepos()
+route: DELETE /user/interaction-limits
+scope: interactions
+type: API method
+---
+
+# Remove interaction restrictions from your public repositories
+
+Removes any interaction restrictions from your public repositories.
+
+```js
+octokit.interactions.removeRestrictionsForYourPublicRepos();
+```
+
+## Parameters
+
+This endpoint has no parameters
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories).
diff --git a/docs/interactions/setRestrictionsForOrg.md b/docs/interactions/setRestrictionsForOrg.md
@@ -8,7 +8,7 @@ type: API method
 
 # Set interaction restrictions for an organization
 
-Temporarily restricts interactions to certain GitHub users in any public repository in the given organization. You must be an organization owner to set these restrictions.
+Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.
 
 ```js
 octokit.interactions.setRestrictionsForOrg({
@@ -33,7 +33,12 @@ octokit.interactions.setRestrictionsForOrg({
 </td></tr>
 <tr><td>limit</td><td>yes</td><td>
 
-Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.
+The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`.
+
+</td></tr>
+<tr><td>expiry</td><td>no</td><td>
+
+The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`.
 
 </td></tr>
   </tbody>
diff --git a/docs/interactions/setRestrictionsForRepo.md b/docs/interactions/setRestrictionsForRepo.md
@@ -8,7 +8,7 @@ type: API method
 
 # Set interaction restrictions for a repository
 
-Temporarily restricts interactions to certain GitHub users within the given repository. You must have owner or admin access to set restrictions.
+Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.
 
 ```js
 octokit.interactions.setRestrictionsForRepo({
@@ -37,7 +37,12 @@ octokit.interactions.setRestrictionsForRepo({
 </td></tr>
 <tr><td>limit</td><td>yes</td><td>
 
-Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.
+The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`.
+
+</td></tr>
+<tr><td>expiry</td><td>no</td><td>
+
+The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`.
 
 </td></tr>
   </tbody>
diff --git a/docs/interactions/setRestrictionsForYourPublicRepos.md b/docs/interactions/setRestrictionsForYourPublicRepos.md
@@ -0,0 +1,43 @@
+---
+name: Set interaction restrictions for your public repositories
+example: octokit.interactions.setRestrictionsForYourPublicRepos({ limit })
+route: PUT /user/interaction-limits
+scope: interactions
+type: API method
+---
+
+# Set interaction restrictions for your public repositories
+
+Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.
+
+```js
+octokit.interactions.setRestrictionsForYourPublicRepos({
+  limit,
+});
+```
+
+## Parameters
+
+<table>
+  <thead>
+    <tr>
+      <th>name</th>
+      <th>required</th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr><td>limit</td><td>yes</td><td>
+
+The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`.
+
+</td></tr>
+<tr><td>expiry</td><td>no</td><td>
+
+The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`.
+
+</td></tr>
+  </tbody>
+</table>
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories).
diff --git a/docs/repos/addAppAccessRestrictions.md b/docs/repos/addAppAccessRestrictions.md
@@ -49,8 +49,6 @@ branch+ parameter
 </td></tr>
 <tr><td>apps</td><td>yes</td><td>
 
-apps parameter
-
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/repos/addStatusCheckContexts.md b/docs/repos/addStatusCheckContexts.md
@@ -43,8 +43,6 @@ branch+ parameter
 </td></tr>
 <tr><td>contexts</td><td>yes</td><td>
 
-contexts parameter
-
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/repos/addTeamAccessRestrictions.md b/docs/repos/addTeamAccessRestrictions.md
@@ -49,8 +49,6 @@ branch+ parameter
 </td></tr>
 <tr><td>teams</td><td>yes</td><td>
 
-teams parameter
-
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/repos/addUserAccessRestrictions.md b/docs/repos/addUserAccessRestrictions.md
@@ -49,8 +49,6 @@ branch+ parameter
 </td></tr>
 <tr><td>users</td><td>yes</td><td>
 
-users parameter
-
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/repos/getCommunityProfileMetrics.md b/docs/repos/getCommunityProfileMetrics.md
@@ -8,7 +8,12 @@ type: API method
 
 # Get community profile metrics
 
-This endpoint will return all community profile metrics, including an overall health score, repository description, the presence of documentation, detected code of conduct, detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE, README, and CONTRIBUTING files.
+This endpoint will return all community profile metrics, including an
+overall health score, repository description, the presence of documentation, detected
+code of conduct, detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,
+README, and CONTRIBUTING files.
+
+`content_reports_enabled` is only returned for organization-owned repositories.
 
 ```js
 octokit.repos.getCommunityProfileMetrics({
diff --git a/docs/repos/removeAppAccessRestrictions.md b/docs/repos/removeAppAccessRestrictions.md
@@ -49,8 +49,6 @@ branch+ parameter
 </td></tr>
 <tr><td>apps</td><td>yes</td><td>
 
-apps parameter
-
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/repos/removeStatusCheckContexts.md b/docs/repos/removeStatusCheckContexts.md
@@ -43,8 +43,6 @@ branch+ parameter
 </td></tr>
 <tr><td>contexts</td><td>yes</td><td>
 
-contexts parameter
-
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/repos/removeTeamAccessRestrictions.md b/docs/repos/removeTeamAccessRestrictions.md
@@ -49,8 +49,6 @@ branch+ parameter
 </td></tr>
 <tr><td>teams</td><td>yes</td><td>
 
-teams parameter
-
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/repos/removeUserAccessRestrictions.md b/docs/repos/removeUserAccessRestrictions.md
@@ -49,8 +49,6 @@ branch+ parameter
 </td></tr>
 <tr><td>users</td><td>yes</td><td>
 
-users parameter
-
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/repos/setAppAccessRestrictions.md b/docs/repos/setAppAccessRestrictions.md
@@ -49,8 +49,6 @@ branch+ parameter
 </td></tr>
 <tr><td>apps</td><td>yes</td><td>
 
-apps parameter
-
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/repos/setStatusCheckContexts.md b/docs/repos/setStatusCheckContexts.md
@@ -43,8 +43,6 @@ branch+ parameter
 </td></tr>
 <tr><td>contexts</td><td>yes</td><td>
 
-contexts parameter
-
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/repos/setTeamAccessRestrictions.md b/docs/repos/setTeamAccessRestrictions.md
@@ -49,8 +49,6 @@ branch+ parameter
 </td></tr>
 <tr><td>teams</td><td>yes</td><td>
 
-teams parameter
-
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/repos/setUserAccessRestrictions.md b/docs/repos/setUserAccessRestrictions.md
@@ -49,8 +49,6 @@ branch+ parameter
 </td></tr>
 <tr><td>users</td><td>yes</td><td>
 
-users parameter
-
 </td></tr>
   </tbody>
 </table>
diff --git a/docs/search/issuesAndPullRequests.md b/docs/search/issuesAndPullRequests.md
@@ -17,7 +17,7 @@ For example, if you want to find the oldest unresolved Python bugs on Windows. Y
 
 `q=windows+label:bug+language:python+state:open&sort=created&order=asc`
 
-This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, whick means the oldest issues appear first in the search results.
+This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
 
 **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)."
 
