Skip to content

Commit 6788a13

Browse files
authored
Update frontmatter and intro info for the apps API (#27345)
1 parent 9606355 commit 6788a13

File tree

5 files changed

+27
-9
lines changed

5 files changed

+27
-9
lines changed

content/rest/apps/apps.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: Apps
3-
intro: 'The GitHub Apps API enables you to retrieve the information about the installation as well as specific information about GitHub Apps.'
2+
title: GitHub Apps
3+
allowTitleToDifferFromFilename: true
4+
intro: 'The {% data variables.product.prodname_github_apps %} API enables you to retrieve information about {% data variables.product.prodname_github_apps %}.'
45
topics:
56
- API
67
miniTocMaxHeadingLevel: 3
@@ -11,12 +12,14 @@ versions:
1112
ghec: '*'
1213
---
1314

15+
## About the {% data variables.product.prodname_github_apps %} API
16+
1417
{% data reusables.apps.general-apps-restrictions %}
1518

1619
This page lists endpoints that you can access while authenticated as a GitHub App. See "[Authenticating as a GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)" to learn more.
1720

1821
When authenticated as a GitHub App, the GitHub Apps API enables you to get high-level information about a GitHub App as well as specific information about installations of an app.
1922

20-
You can access REST API v3 endpoints while authenticated as a GitHub App. These endpoints have a "Notes" section that contains a bullet point that says "Works with GitHub Apps." You can also access these endpoints while authenticated as a user.
23+
You can access REST API v3 endpoints while authenticated as a GitHub App. These endpoints have text that says "Works with GitHub Apps." You can also access these endpoints while authenticated as a user.
2124

2225
A subset of REST API v3 endpoints requires authenticating as a GitHub App installation. See [Installations](/rest/reference/apps#installations) for a list of these endpoints.

content/rest/apps/installations.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
title: Installations
3-
intro: 'The Installations API enables you to get information about installations of your GitHub App and perform actions within those installations.'
2+
title: GitHub App installations
3+
allowTitleToDifferFromFilename: true
4+
shortTitle: Installations
5+
intro: 'The {% data variables.product.prodname_github_app %} installations API enables you to get information about installations of your {% data variables.product.prodname_github_app %} and perform actions within those installations.'
46
topics:
57
- API
68
miniTocMaxHeadingLevel: 3
@@ -11,6 +13,8 @@ versions:
1113
ghec: '*'
1214
---
1315

16+
## About the {% data variables.product.prodname_github_app %} installations API
17+
1418
An _installation_ refers to any user or organization account that has installed the app. For information on how to authenticate as an installation and limit access to specific repositories, see "[Authenticating as an installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)."
1519

1620
To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/reference/orgs#list-app-installations-for-an-organization)."

content/rest/apps/marketplace.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
2-
title: Marketplace
2+
title: GitHub Marketplace
3+
allowTitleToDifferFromFilename: true
4+
shortTitle: Marketplace
35
intro: ''
46
topics:
57
- API
@@ -9,6 +11,8 @@ versions:
911
ghec: '*'
1012
---
1113

14+
## About the {% data variables.product.prodname_marketplace %} API
15+
1216
For more information about {% data variables.product.prodname_marketplace %}, see "[GitHub Marketplace](/marketplace/)."
1317

1418
The {% data variables.product.prodname_marketplace %} API allows you to see which customers are using a pricing plan, see a customer's purchases, and see if an account has an active subscription.

content/rest/apps/oauth-applications.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: OAuth Applications
2+
title: OAuth Apps
3+
allowTitleToDifferFromFilename: true
34
intro: ''
45
topics:
56
- API
@@ -11,4 +12,6 @@ versions:
1112
ghec: '*'
1213
---
1314

14-
You can use this API to manage the OAuth tokens an OAuth application uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.
15+
## About the {% data variables.product.prodname_oauth_app %} API
16+
17+
You can use this API to manage the OAuth tokens an {% data variables.product.prodname_oauth_app %} uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.

content/rest/apps/webhooks.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
2-
title: Webhooks
2+
title: GitHub App webhooks
3+
allowTitleToDifferFromFilename: true
4+
shortTitle: Webhooks
35
intro: ''
46
topics:
57
- API
@@ -11,4 +13,6 @@ versions:
1113
ghec: '*'
1214
---
1315

16+
## About the {% data variables.product.prodname_github_app %} webhooks API
17+
1418
A {% data variables.product.prodname_github_app %}'s webhook allows you to receive HTTP `POST` payloads whenever certain events happen for an app. {% data reusables.webhooks.webhooks-rest-api-links %}

0 commit comments

Comments
 (0)