Skip to content

Commit 9606355

Browse files
Update frontmatter and intro info for the codespaces API (#27333)
Co-authored-by: Lucas Costi <[email protected]>
1 parent b5c8836 commit 9606355

File tree

4 files changed

+21
-12
lines changed

4 files changed

+21
-12
lines changed

content/rest/codespaces/codespaces.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,6 @@ miniTocMaxHeadingLevel: 3
1111

1212
{% data reusables.codespaces.codespaces-api-beta-note %}
1313

14+
## About the Codespaces API
15+
1416
The {% data variables.product.prodname_codespaces %} API enables you to manage {% data variables.product.prodname_codespaces %} using the REST API. This API is available for authenticated users and OAuth Apps, but not GitHub Apps. For more information, see "[{% data variables.product.prodname_codespaces %}](/codespaces)."

content/rest/codespaces/machines.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
title: Machines
3-
intro: 'The Machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user.'
2+
title: Codespaces machines
3+
allowTitleToDifferFromFilename: true
4+
shortTitle: Machines
5+
intro: 'The Codespaces machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user.'
46
versions:
57
fpt: '*'
68
ghec: '*'
@@ -9,6 +11,8 @@ topics:
911
miniTocMaxHeadingLevel: 3
1012
---
1113

12-
For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)."
14+
## About the Codespaces machines API
15+
16+
The Codespaces machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user. For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)."
1317

1418
You can also use this information when changing the machine of an existing codespace by updating its `machine` property. The machine update will take place the next time the codespace is restarted. For more information, see "[Changing the machine type for your codespace](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace)."
Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
title: Repository Secrets
3-
intro: 'The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to.'
2+
title: Codespaces repository secrets
3+
allowTitleToDifferFromFilename: true
4+
shortTitle: Repository secrets
5+
intro: 'The Codespaces repository secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to in a codespace.'
46
versions:
57
fpt: '*'
68
ghec: '*'
@@ -10,6 +12,6 @@ topics:
1012
miniTocMaxHeadingLevel: 3
1113
---
1214

13-
## Repository Secrets
15+
## About the Codespaces repository secrets API
1416

15-
The Repository Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."
17+
The Codespaces repository secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."

content/rest/codespaces/secrets.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
2-
title: User Secrets
3-
intro: 'The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to.'
2+
title: Codespaces user secrets
3+
allowTitleToDifferFromFilename: true
4+
shortTitle: User secrets
5+
intro: 'The Codespaces user secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to in a codespace.'
46
versions:
57
fpt: '*'
68
ghec: '*'
79
topics:
810
- API
911
miniTocMaxHeadingLevel: 3
10-
allowTitleToDifferFromFilename: true
1112
---
1213

13-
## User Secrets
14+
## About the Codespaces user secrets API
1415

15-
The User Secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."
16+
The Codespaces user secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."

0 commit comments

Comments
 (0)