From 020ed4c2b59ea65628cf992af7803c4a65ca8bbd Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Mon, 2 Jan 2023 22:50:05 -0800 Subject: [PATCH] Unify language in the REST API for interactions (#33692) Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> --- content/rest/interactions/index.md | 7 +++++-- content/rest/interactions/orgs.md | 6 +++--- content/rest/interactions/repos.md | 7 ++++--- content/rest/interactions/user.md | 6 +++--- 4 files changed, 15 insertions(+), 11 deletions(-) diff --git a/content/rest/interactions/index.md b/content/rest/interactions/index.md index 3d9113b66e..5a5f814415 100644 --- a/content/rest/interactions/index.md +++ b/content/rest/interactions/index.md @@ -1,6 +1,7 @@ --- title: Interactions -intro: 'With the Interactions API, people with owner or admin access can set the interaction limit for the users in their organizations and repositories.' +intro: 'Use the REST API to set the interaction limit for the users in your organizations and repositories.' +permissions: People with owner or admin access can set the interaction limit for the users in their organizations and repositories. redirect_from: - /v3/interactions - /rest/reference/interactions @@ -16,4 +17,6 @@ children: - /user --- -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. +## About interactions + +Users interact with repositories by commenting, opening issues, and creating pull requests. You can use the REST API to allow people with owner or admin access to temporarily restrict interaction with public repositories to a certain type of user. diff --git a/content/rest/interactions/orgs.md b/content/rest/interactions/orgs.md index 4a8c15b6bb..b1c695e693 100644 --- a/content/rest/interactions/orgs.md +++ b/content/rest/interactions/orgs.md @@ -1,7 +1,7 @@ --- title: Organization interactions shortTitle: Organization -intro: '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.' +intro: 'Use the REST API to temporarily restrict which type of user can comment, open issues, or create pull requests in the organization''s public repositories.' versions: fpt: '*' ghec: '*' @@ -11,9 +11,9 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the Organization interactions API +## About organization interactions -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: +Organization owners can 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. diff --git a/content/rest/interactions/repos.md b/content/rest/interactions/repos.md index c9c5d16ccf..855b62cbc3 100644 --- a/content/rest/interactions/repos.md +++ b/content/rest/interactions/repos.md @@ -1,7 +1,8 @@ --- title: Repository interactions shortTitle: Repository -intro: '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.' +intro: 'Use the REST API to temporarily restrict which type of user can comment, open issues, or create pull requests in a public repository.' +permissions: 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. versions: fpt: '*' ghec: '*' @@ -11,9 +12,9 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the Repository interactions API +## About repository interactions -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: +People with owner or admin access can use the REST API 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. diff --git a/content/rest/interactions/user.md b/content/rest/interactions/user.md index 7f3b8c25a0..327cb62de5 100644 --- a/content/rest/interactions/user.md +++ b/content/rest/interactions/user.md @@ -2,7 +2,7 @@ title: User interactions shortTitle: User allowTitleToDifferFromFilename: true -intro: '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.' +intro: 'Use the REST API to temporarily restrict which type of user can comment, open issues, or create pull requests in your public repositories.' versions: fpt: '*' ghec: '*' @@ -11,9 +11,9 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the User interactions API +## About user interactions -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: +You can use the REST API 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.