diff --git a/content/rest/reference/interactions.md b/content/rest/reference/interactions.md index 9ab1cdd10c27..1fb73f9948c4 100644 --- a/content/rest/reference/interactions.md +++ b/content/rest/reference/interactions.md @@ -6,7 +6,7 @@ versions: free-pro-team: '*' --- -Users interact with repositories by commenting, opening issues, and creating pull requests. The Interactions APIs allow people with owner or admin access to temporarily restrict certain users from interacting with public repositories. +Users interact with repositories by commenting, opening issues, and creating pull requests. The Interactions APIs allow people with owner or admin access to temporarily restrict interaction with public repositories to a certain type of user. {% for operation in currentRestOperations %} {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} @@ -14,24 +14,42 @@ Users interact with repositories by commenting, opening issues, and creating pul ## Organization -The Organization Interactions API allows organization owners to temporarily restrict which users can comment, open issues, or create pull requests in the organization's public repositories. {% data reusables.interactions.interactions-detail %} Here's more about the groups of {% data variables.product.product_name %} users: +The Organization Interactions API allows organization owners to temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: * {% data reusables.interactions.existing-user-limit-definition %} in the organization. * {% data reusables.interactions.contributor-user-limit-definition %} in the organization. * {% data reusables.interactions.collaborator-user-limit-definition %} in the organization. +Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. To set different interaction limits for individual repositories owned by the organization, use the [Repository](#repository) interactions endpoints instead. + {% for operation in currentRestOperations %} {% if operation.subcategory == 'orgs' %}{% include rest_operation %}{% endif %} {% endfor %} ## Repository -The Repository Interactions API allows people with owner or admin access to temporarily restrict which users can comment, open issues, or create pull requests in a public repository. {% data reusables.interactions.interactions-detail %} Here's more about the groups of {% data variables.product.product_name %} users: +The Repository Interactions API allows people with owner or admin access to temporarily restrict which type of user can comment, open issues, or create pull requests in a public repository. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: * {% data reusables.interactions.existing-user-limit-definition %} in the repository. * {% data reusables.interactions.contributor-user-limit-definition %} in the repository. * {% data reusables.interactions.collaborator-user-limit-definition %} in the repository. +If an interaction limit is enabled for the user or organization that owns the repository, the limit cannot be changed for the individual repository. Instead, use the [User](#user) or [Organization](#organization) interactions endpoints to change the interaction limit. + {% for operation in currentRestOperations %} {% if operation.subcategory == 'repos' %}{% include rest_operation %}{% endif %} {% endfor %} + +## User + +The User Interactions API allows you to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: + +* {% data reusables.interactions.existing-user-limit-definition %} from interacting with your repositories. +* {% data reusables.interactions.contributor-user-limit-definition %} from interacting with your repositories. +* {% data reusables.interactions.collaborator-user-limit-definition %} from interacting with your repositories. + +Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. To set different interaction limits for individual repositories owned by the user, use the [Repository](#repository) interactions endpoints instead. + +{% for operation in currentRestOperations %} + {% if operation.subcategory == 'user' %}{% include rest_operation %}{% endif %} +{% endfor %} diff --git a/data/reusables/interactions/interactions-detail.md b/data/reusables/interactions/interactions-detail.md index 9193cd04e704..187a3e73074d 100644 --- a/data/reusables/interactions/interactions-detail.md +++ b/data/reusables/interactions/interactions-detail.md @@ -1 +1 @@ -When restrictions are enabled, only the specified group of {% data variables.product.product_name %} users will be able to participate in interactions. Restrictions expire 24 hours from the time they are set. +When restrictions are enabled, only the specified type of {% data variables.product.product_name %} user will be able to participate in interactions. Restrictions automatically expire after a defined duration. diff --git a/package-lock.json b/package-lock.json index effbb8d90bba..3eedee2abf46 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1151,9 +1151,9 @@ } }, "@github/rest-api-operations": { - "version": "3.6.2", - "resolved": "https://registry.npmjs.org/@github/rest-api-operations/-/rest-api-operations-3.6.2.tgz", - "integrity": "sha512-SgJY+Or4AFwfcrkzrgIY+HB1Q9jZQZFtlE+ThzY21EoX3/wACOjYIogWwB2qqB2lggr1+UOv1Mm/BaXBLeoF0w==" + "version": "3.7.0", + "resolved": "https://registry.npmjs.org/@github/rest-api-operations/-/rest-api-operations-3.7.0.tgz", + "integrity": "sha512-qe9tMxtz5POaQk0hlH55uvbiVesxUfR0Qn0uq/R8Ak2I13h3aK79+XKbIT4HPXfm08X3sCWEJEK2kLg3UlTRsw==" }, "@hapi/address": { "version": "2.1.4", diff --git a/package.json b/package.json index c5519b8cf73f..18fb6fcf2d71 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,7 @@ "@github-docs/data-directory": "^1.2.0", "@github-docs/frontmatter": "^1.3.1", "@github-docs/render-content": "^5.2.0", - "@github/rest-api-operations": "^3.6.2", + "@github/rest-api-operations": "^3.7.0", "@octokit/rest": "^16.38.1", "@primer/css": "^15.1.0", "@primer/octicons": "^11.0.0",