You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/rest/reference/interactions.md
+21-3Lines changed: 21 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -6,32 +6,50 @@ versions:
6
6
free-pro-team: '*'
7
7
---
8
8
9
-
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.
9
+
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.
10
10
11
11
{% for operation in currentRestOperations %}
12
12
{% unless operation.subcategory %}{% include rest_operation %}{% endunless %}
13
13
{% endfor %}
14
14
15
15
## Organization
16
16
17
-
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:
17
+
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:
18
18
19
19
* {% data reusables.interactions.existing-user-limit-definition %} in the organization.
20
20
* {% data reusables.interactions.contributor-user-limit-definition %} in the organization.
21
21
* {% data reusables.interactions.collaborator-user-limit-definition %} in the organization.
22
22
23
+
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.
24
+
23
25
{% for operation in currentRestOperations %}
24
26
{% if operation.subcategory == 'orgs' %}{% include rest_operation %}{% endif %}
25
27
{% endfor %}
26
28
27
29
## Repository
28
30
29
-
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:
31
+
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:
30
32
31
33
* {% data reusables.interactions.existing-user-limit-definition %} in the repository.
32
34
* {% data reusables.interactions.contributor-user-limit-definition %} in the repository.
33
35
* {% data reusables.interactions.collaborator-user-limit-definition %} in the repository.
34
36
37
+
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.
38
+
35
39
{% for operation in currentRestOperations %}
36
40
{% if operation.subcategory == 'repos' %}{% include rest_operation %}{% endif %}
37
41
{% endfor %}
42
+
43
+
## User
44
+
45
+
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:
46
+
47
+
* {% data reusables.interactions.existing-user-limit-definition %} from interacting with your repositories.
48
+
* {% data reusables.interactions.contributor-user-limit-definition %} from interacting with your repositories.
49
+
* {% data reusables.interactions.collaborator-user-limit-definition %} from interacting with your repositories.
50
+
51
+
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.
52
+
53
+
{% for operation in currentRestOperations %}
54
+
{% if operation.subcategory == 'user' %}{% include rest_operation %}{% endif %}
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.
1
+
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.
0 commit comments