Skip to content

Commit f075a91

Browse files
authored
Merge pull request github#17444 from github/repo-sync
repo sync
2 parents 74c7630 + 10ea489 commit f075a91

15 files changed

+48
-18
lines changed

content/rest/billing.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Billing
3-
intro: ''
3+
intro: 'The Billing API lets you get billing information for an enterprise.'
44
topics:
55
- API
66
miniTocMaxHeadingLevel: 3
@@ -12,4 +12,6 @@ redirect_from:
1212
- /rest/reference/billing
1313
---
1414

15+
## About the Billing API
16+
1517
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.

content/rest/code-scanning.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Code Scanning
3-
intro: ''
3+
intro: 'The {% data variables.product.prodname_code_scanning %} API lets you retrieve and update {% data variables.product.prodname_code_scanning %} alerts from a repository.'
44
versions:
55
fpt: '*'
66
ghes: '*'
@@ -17,6 +17,8 @@ redirect_from:
1717

1818
{% data reusables.code-scanning.beta %}
1919

20+
## About the Code scanning API
21+
2022
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)."
2123

2224
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}

content/rest/codes-of-conduct.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Codes of Conduct
3-
intro: ''
2+
title: Codes of conduct
3+
intro: "The Codes of conduct API lets you retrieve information about a repository's code of conduct."
44
versions:
55
fpt: '*'
66
ghes: '*'
@@ -13,4 +13,6 @@ redirect_from:
1313
- /rest/reference/codes-of-conduct
1414
---
1515

16-
You can use the Codes of Conduct API to retrieve information about a repository's code of conduct. To get a repository's code of conduct, use the "[Get a repository](/rest/reference/repos#get-a-repository)" endpoint.
16+
## About the Codes of conduct API
17+
18+
You can use the Codes of Conduct API to retrieve information about a repository's code of conduct. To get a code of conduct for a repository, use the "[Get a repository](/rest/reference/repos#get-a-repository)" endpoint.

content/rest/commits/comments.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Commit comments
3-
intro: ''
3+
intro: 'The Commit comments API lets you create and edit comments that relate to specific commits.'
44
versions:
55
fpt: '*'
66
ghes: '*'
@@ -12,6 +12,10 @@ miniTocMaxHeadingLevel: 3
1212
allowTitleToDifferFromFilename: true
1313
---
1414

15+
## About the commit comments API
16+
17+
The Commit comments API lets you create and edit comments that relate to specific commits.
18+
1519
### Custom media types for commit comments
1620

1721
These are the supported media types for commit comments. You can read more

content/rest/commits/statuses.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Commit statuses
3-
intro: 'The status API allows external services to mark commits with an `error`, `failure`, `pending`, or `success` state, which is then reflected in pull requests involving those commits.'
3+
intro: 'The Commit status API allows external services to mark commits with a status, which is then reflected in pull requests involving those commits.'
44
versions:
55
fpt: '*'
66
ghes: '*'
@@ -12,7 +12,9 @@ miniTocMaxHeadingLevel: 3
1212
allowTitleToDifferFromFilename: true
1313
---
1414

15-
Statuses can also include an optional `description` and `target_url`, and we highly recommend providing them as they make statuses much more useful in the GitHub UI.
15+
## About the Commit statuses API
16+
17+
The Commit status API allows external services to mark commits with an `error`, `failure`, `pending`, or `success` state, which is then reflected in pull requests involving those commits. Statuses can also include an optional `description` and `target_url`, and we highly recommend providing them as they make statuses much more useful in the GitHub UI.
1618

1719
As an example, one common use is for continuous integration services to mark commits as passing or failing builds using status. The `target_url` would be the full URL to the build output, and the `description` would be the high level summary of what happened with the build.
1820

content/rest/deploy-keys.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Deploy Keys
3-
intro: ''
2+
title: Deploy keys
3+
intro: 'The Deploy keys API lets you create and manage deploy keys.'
44
versions:
55
fpt: '*'
66
ghes: '*'
@@ -14,6 +14,8 @@ redirect_from:
1414
- /rest/reference/deploy_keys
1515
---
1616

17+
## About the Deploy keys API
18+
1719
{% data reusables.repositories.deploy-keys %}
1820

1921
Deploy keys can either be setup using the following API endpoints, or by using GitHub. To learn how to set deploy keys up in GitHub, see "[Managing deploy keys](/developers/overview/managing-deploy-keys)."

content/rest/gitignore.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ redirect_from:
1313
- /rest/reference/gitignore
1414
---
1515

16+
## About the Gitignore API
17+
1618
When you create a new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} via the API, you can specify a [.gitignore template](/github/getting-started-with-github/ignoring-files) to apply to the repository upon creation. The .gitignore templates API lists and fetches templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore).
1719

1820
### Custom media types for gitignore

content/rest/licenses.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ redirect_from:
1313
- /rest/reference/licenses
1414
---
1515

16+
## About the Licenses API
17+
1618
The Licenses API uses [the open source Ruby Gem Licensee](https://github.com/benbalter/licensee) to attempt to identify the project's license. Licensee matches the contents of a project's `LICENSE` file (if it exists) against a short list of known licenses. As a result, the API does not take into account the licenses of project dependencies or other means of documenting a project's license such as references to the license name in the documentation.
1719

1820
If a license is matched, the license key and name returned conforms to the [SPDX specification](https://spdx.org/).

content/rest/oauth-authorizations.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: OAuth Authorizations
3-
intro: 'The Migrations API is only available to authenticated organization owners.'
2+
title: OAuth authorizations
3+
intro: 'The OAuth authorizations lets you manage the access OAuth applications have to your account.'
44
versions:
55
fpt: '*'
66
ghec: '*'
@@ -12,6 +12,8 @@ redirect_from:
1212
- /rest/reference/oauth-authorizations
1313
---
1414

15+
## About the OAuth authorizations API
16+
1517
You can use this API to manage the access OAuth applications have to your account. You can only access this API via [Basic Authentication](/rest/overview/other-authentication-methods#basic-authentication) using your username and password, not tokens.
1618

1719
If you or your users have two-factor authentication enabled, make sure you understand how to [work with two-factor authentication](/rest/overview/other-authentication-methods#working-with-two-factor-authentication).

content/rest/packages.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ redirect_from:
1111
- /rest/reference/packages
1212
---
1313

14+
## About the {% data variables.product.prodname_registry %} API
15+
1416
The {% data variables.product.prodname_registry %} API enables you to manage packages using the REST API.{% ifversion fpt or ghec or ghes > 3.1 or ghae %} To learn more about restoring or deleting packages, see "[Restoring and deleting packages](/packages/learn-github-packages/deleting-and-restoring-a-package)."{% endif %}
1517

1618
To use this API, you must authenticate using a personal access token.

0 commit comments

Comments
 (0)