Skip to content

Commit cb37f22

Browse files
rachmariSarah Edwards
rachmari
and
Sarah Edwards
authored
automate github apps docs (#35530)
Co-authored-by: Sarah Edwards <skedwards88@github.com>
1 parent b0ea5f5 commit cb37f22

File tree

89 files changed

+224477
-21366
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+224477
-21366
lines changed

‎.github/workflows/sync-openapi.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ jobs:
5050
- uses: ./.github/actions/node-npm-setup
5151

5252
- name: Sync the REST, Webhooks, and GitHub Apps schemas
53+
env:
54+
# Needed for gh
55+
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_FR }}
5356
run: |
5457
src/rest/scripts/update-files.js --source-repo rest-api-description --output rest github-apps webhooks rest-redirects
5558
git status

‎content/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens.md‎

Lines changed: 2 additions & 864 deletions
Large diffs are not rendered by default.

‎content/rest/overview/endpoints-available-for-github-app-installation-access-tokens.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Endpoints available for GitHub App installation access tokens
3+
shortTitle: Endpoints for GitHub App installation tokens
4+
intro: Your GitHub App can make requests to the following REST endpoints with an installation access token.
5+
permissions: 'You can use an installation access token to access these endpoints using your {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation)."'
6+
redirect_from:
7+
- /v3/apps/available-endpoints
8+
- /rest/reference/endpoints-available-for-github-apps
9+
- /rest/overview/endpoints-available-for-github-apps
10+
versions:
11+
fpt: '*'
12+
ghes: '*'
13+
ghae: '*'
14+
ghec: '*'
15+
topics:
16+
- API
17+
autogenerated: github-apps
18+
---
19+
20+
21+
22+
<!-- The content of this page is rendered as a NextJS page component. -->

‎content/rest/overview/endpoints-available-for-github-app-user-access-tokens.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Endpoints available for GitHub App user access tokens
3+
shortTitle: Endpoints for GitHub App user tokens
4+
intro: 'Your GitHub App can make requests to the following REST endpoints with a user access token.'
5+
permissions: 'You can use a user access token to access these endpoints using your {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)."'
6+
versions:
7+
fpt: '*'
8+
ghes: '*'
9+
ghae: '*'
10+
ghec: '*'
11+
topics:
12+
- API
13+
- GitHub Apps
14+
autogenerated: github-apps
15+
---
16+
17+
18+
19+
<!-- The content of this page is rendered as a NextJS page component. -->

‎content/rest/overview/endpoints-available-for-github-apps.md‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎content/rest/overview/index.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ children:
1919
- /troubleshooting
2020
- /libraries
2121
- /openapi-description
22-
- /endpoints-available-for-github-apps
22+
- /endpoints-available-for-github-app-installation-access-tokens
23+
- /endpoints-available-for-github-app-user-access-tokens
2324
- /endpoints-available-for-fine-grained-personal-access-tokens
2425
- /permissions-required-for-github-apps
2526
- /permissions-required-for-fine-grained-personal-access-tokens

‎content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md‎

Lines changed: 2 additions & 975 deletions
Large diffs are not rendered by default.

‎content/rest/overview/permissions-required-for-github-apps.md‎

Lines changed: 3 additions & 1058 deletions
Large diffs are not rendered by default.

‎data/ui.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,14 @@ products:
134134
actions_api_title: Actions
135135
versioning:
136136
about_versions: About REST API versions
137+
overview:
138+
permissions:
139+
access: Access
140+
endpoints: Endpoint
141+
tokens: Token types
142+
additionalPermissions: Additional permissions
143+
uat: UAT
144+
iat: IAT
137145
reference:
138146
in: In
139147
description: Description

0 commit comments

Comments
 (0)