diff --git a/content/rest/billing.md b/content/rest/billing.md index 3a27043712a0..d9da8dd72236 100644 --- a/content/rest/billing.md +++ b/content/rest/billing.md @@ -1,6 +1,6 @@ --- title: Billing -intro: The Billing API lets you get billing information for an enterprise. +intro: Use the REST API to get billing information for an enterprise. topics: - API miniTocMaxHeadingLevel: 3 @@ -12,6 +12,6 @@ redirect_from: - /rest/reference/billing --- -## About the Billing API +## About billing -You can get billing information for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#billing)" REST API. +You can get billing information for an enterprise. For more information, see "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#billing)." diff --git a/content/rest/branches/branch-protection.md b/content/rest/branches/branch-protection.md index d33ae8f7cfe5..73cd9751e46b 100644 --- a/content/rest/branches/branch-protection.md +++ b/content/rest/branches/branch-protection.md @@ -1,6 +1,6 @@ --- title: Protected branches -intro: '' +intro: 'Use the REST API to manage protected branches.' versions: fpt: '*' ghes: '*' diff --git a/content/rest/branches/branches.md b/content/rest/branches/branches.md index 82bacb78f263..ba663344b515 100644 --- a/content/rest/branches/branches.md +++ b/content/rest/branches/branches.md @@ -1,6 +1,6 @@ --- title: Branches -intro: The Branches API allows you to modify branches and their protection settings. +intro: Use the REST API to modify branches and their protection settings. versions: fpt: '*' ghes: '*' diff --git a/content/rest/branches/index.md b/content/rest/branches/index.md index 5e677e3493a4..587702234d27 100644 --- a/content/rest/branches/index.md +++ b/content/rest/branches/index.md @@ -1,6 +1,6 @@ --- title: Branches -intro: The branches API allows you to modify branches and their protection settings. +intro: Use the REST API to modify branches and their protection settings. allowTitleToDifferFromFilename: true versions: fpt: '*' diff --git a/content/rest/checks/index.md b/content/rest/checks/index.md index cd92f04a1016..a5823ab2e2ca 100644 --- a/content/rest/checks/index.md +++ b/content/rest/checks/index.md @@ -1,6 +1,6 @@ --- title: Checks -intro: 'With the Checks API, you can build {% data variables.product.prodname_github_apps %} that run powerful checks against the code changes in a repository.' +intro: 'Use the REST API to build {% data variables.product.prodname_github_apps %} that run powerful checks against the code changes in a repository.' redirect_from: - /v3/checks - /rest/reference/checks @@ -17,4 +17,4 @@ children: - /suites --- -You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits. For more information, see "[Getting started with the checks API](/rest/guides/getting-started-with-the-checks-api)" and "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)." +You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits. For more information, see "[Using the REST API to interact with checks](/rest/guides/using-the-rest-api-to-interact-with-checks)" and "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)." diff --git a/content/rest/checks/runs.md b/content/rest/checks/runs.md index a4d1ae5dc562..853fda9d80a0 100644 --- a/content/rest/checks/runs.md +++ b/content/rest/checks/runs.md @@ -1,6 +1,6 @@ --- title: Check Runs -intro: '' +intro: 'Use the REST API to manage check runs.' versions: fpt: '*' ghes: '*' diff --git a/content/rest/checks/suites.md b/content/rest/checks/suites.md index d9ce69afc967..422ede66b558 100644 --- a/content/rest/checks/suites.md +++ b/content/rest/checks/suites.md @@ -1,6 +1,6 @@ --- title: Check Suites -intro: '' +intro: 'Use the REST API to manage check suites.' versions: fpt: '*' ghes: '*' diff --git a/content/rest/code-scanning.md b/content/rest/code-scanning.md index 22206e92fa1b..966dc62810be 100644 --- a/content/rest/code-scanning.md +++ b/content/rest/code-scanning.md @@ -1,6 +1,6 @@ --- title: Code Scanning -intro: 'The {% data variables.product.prodname_code_scanning %} API lets you retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository.' +intro: 'Use the REST API to retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository.' versions: fpt: '*' ghes: '*' @@ -17,13 +17,13 @@ redirect_from: {% data reusables.code-scanning.beta %} -## About the Code scanning API +## About code scanning -The {% data variables.product.prodname_code_scanning %} API lets you retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository. You can use the endpoints to create automated reports for the {% data variables.product.prodname_code_scanning %} alerts in an organization or upload analysis results generated using offline {% data variables.product.prodname_code_scanning %} tools. For more information, see "[Finding security vulnerabilities and errors in your code](/github/finding-security-vulnerabilities-and-errors-in-your-code)." +You can retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository. You can use the endpoints to create automated reports for the {% data variables.product.prodname_code_scanning %} alerts in an organization or upload analysis results generated using offline {% data variables.product.prodname_code_scanning %} tools. For more information, see "[Finding security vulnerabilities and errors in your code](/github/finding-security-vulnerabilities-and-errors-in-your-code)." ### Custom media type for {% data variables.product.prodname_code_scanning %} -There is one supported custom media type for the {% data variables.product.prodname_code_scanning %} REST API. +There is one supported custom media type for {% data variables.product.prodname_code_scanning %} endpoints. application/sarif+json diff --git a/content/rest/collaborators/collaborators.md b/content/rest/collaborators/collaborators.md index 87a3eeec8716..d877ac07b133 100644 --- a/content/rest/collaborators/collaborators.md +++ b/content/rest/collaborators/collaborators.md @@ -1,6 +1,6 @@ --- title: Collaborators -intro: The Collaborators API allows you manage collaborators for a repository. +intro: Use the REST API to manage collaborators for a repository. versions: fpt: '*' ghes: '*' diff --git a/content/rest/collaborators/index.md b/content/rest/collaborators/index.md index 367efbdb7544..8afb72324432 100644 --- a/content/rest/collaborators/index.md +++ b/content/rest/collaborators/index.md @@ -1,6 +1,6 @@ --- title: Collaborators -intro: 'The Collaborators API allows you to add, invite, and remove collaborators from a repository.' +intro: 'Use the REST API to add, invite, and remove collaborators from a repository.' allowTitleToDifferFromFilename: true versions: fpt: '*' diff --git a/content/rest/collaborators/invitations.md b/content/rest/collaborators/invitations.md index d8ddc0314a89..580248af8502 100644 --- a/content/rest/collaborators/invitations.md +++ b/content/rest/collaborators/invitations.md @@ -2,7 +2,7 @@ title: Repository invitations allowTitleToDifferFromFilename: true shortTitle: Invitations -intro: The Repository invitations API allows you to view and manage invitations to collaborate on a repository. +intro: Use the REST API to view and manage invitations to collaborate on a repository. versions: fpt: '*' ghes: '*' @@ -13,11 +13,11 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Repository invitations API +## About repository invitations -The Repository invitations API allows you to view and manage invitations to collaborate on a repository. The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations. +You can view and manage invitations to collaborate on a repository. The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations. -To add a user as a collaborator, use the Collaborators API instead. For more information, see "[Add a repository collaborator](/rest/collaborators/collaborators#add-a-repository-collaborator)." +To add a user as a collaborator, use the Collaborators endpoints instead. For more information, see "[Add a repository collaborator](/rest/collaborators/collaborators#add-a-repository-collaborator)." Note that the `repo:invite` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to invitations **without** also granting access to repository code, while the