Skip to content

Commit ea44900

Browse files
am-steadheiskrfelicitymay
authored
Hack Week 2025: update product.product_name in /content/rest (#54029)
Co-authored-by: Kevin Heis <[email protected]> Co-authored-by: Felicity Chapman <[email protected]>
1 parent 22f8293 commit ea44900

Some content is hidden

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

42 files changed

+94
-94
lines changed

content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: About the OpenAPI description for the REST API
33
shortTitle: OpenAPI description
4-
intro: 'The {% data variables.product.product_name %} REST API is fully described in an OpenAPI compliant document.'
4+
intro: 'The {% data variables.product.github %} REST API is fully described in an OpenAPI compliant document.'
55
versions:
66
fpt: '*'
77
ghes: '*'

content/rest/about-the-rest-api/breaking-changes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ Once your integration is updated, test your integration to verify that it works
2626

2727
## Breaking changes for {{ initialRestVersioningReleaseDate }}
2828

29-
Version `{{ initialRestVersioningReleaseDate }}` is the first version of the {% data variables.product.product_name %} REST API after date-based versioning was introduced. This version does not include any breaking changes.
29+
Version `{{ initialRestVersioningReleaseDate }}` is the first version of the {% data variables.product.github %} REST API after date-based versioning was introduced. This version does not include any breaking changes.

content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Comparing GitHub's REST API and GraphQL API
33
shortTitle: Comparing GitHub's APIs
4-
intro: 'Learn about {% data variables.product.prodname_dotcom %}''s APIs to extend and customize your {% data variables.product.prodname_dotcom %} experience.'
4+
intro: 'Learn about {% data variables.product.github %}''s APIs to extend and customize your {% data variables.product.github %} experience.'
55
redirect_from:
66
- /v3/versions
77
- /articles/getting-started-with-the-api
@@ -29,7 +29,7 @@ This article discusses the benefits of each API. For more information about the
2929

3030
The GraphQL API returns exactly the data that you request. GraphQL also returns the data in a pre-known structure based on your request. In contrast, the REST API returns more data than you requested and returns it in a pre-determined structure. You can also accomplish the equivalent of multiple REST API request in a single GraphQL request. The ability to make fewer requests and fetch less data makes GraphQL appealing to developers of mobile applications.
3131

32-
For example, to get the {% data variables.product.product_name %} login of ten of your followers, and the login of ten followers of each of your followers, you can send a single request like:
32+
For example, to get the {% data variables.product.github %} login of ten of your followers, and the login of ten followers of each of your followers, you can send a single request like:
3333

3434
```graphql
3535
{

content/rest/activity/events.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: REST API endpoints for events
33
shortTitle: Events
44
allowTitleToDifferFromFilename: true
55
intro: >-
6-
Use the REST API to interact with {% data variables.product.prodname_dotcom %}
6+
Use the REST API to interact with {% data variables.product.github %}
77
events.
88
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
99
fpt: '*'
@@ -14,11 +14,11 @@ topics:
1414
autogenerated: rest
1515
---
1616

17-
## About {% data variables.product.prodname_dotcom %} events
17+
## About {% data variables.product.github %} events
1818

19-
{% data variables.product.prodname_dotcom %} events power the various activity streams on the site.
19+
{% data variables.product.github %} events power the various activity streams on the site.
2020

21-
You can use the REST API to return different types of events triggered by activity on {% data variables.product.product_name %}. For more information about the specific events that you can receive, see [AUTOTITLE](/webhooks-and-events/events/github-event-types). Endpoints for repository issues are also available. For more information, see [AUTOTITLE](/rest/issues/events).
21+
You can use the REST API to return different types of events triggered by activity on {% data variables.product.github %}. For more information about the specific events that you can receive, see [AUTOTITLE](/webhooks-and-events/events/github-event-types). Endpoints for repository issues are also available. For more information, see [AUTOTITLE](/rest/issues/events).
2222

2323
Events are optimized for polling with the "ETag" header. If no new events have been triggered, you will see a "304 Not Modified" response, and your current rate limit will be untouched. There is also an "X-Poll-Interval" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header.
2424

content/rest/activity/notifications.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: REST API endpoints for notifications
33
shortTitle: Notifications
44
allowTitleToDifferFromFilename: true
55
intro: >-
6-
Use the REST API to manage {% data variables.product.product_name %}
6+
Use the REST API to manage {% data variables.product.github %}
77
notifications.
88
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
99
fpt: '*'
@@ -14,11 +14,11 @@ topics:
1414
autogenerated: rest
1515
---
1616

17-
## About {% data variables.product.product_name %} notifications
17+
## About {% data variables.product.github %} notifications
1818

1919
{% data reusables.user-settings.notifications-api-classic-pat-only %}
2020

21-
You can use the REST API to manage {% data variables.product.product_name %} notifications. For more information about notifications, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications).
21+
You can use the REST API to manage {% data variables.product.github %} notifications. For more information about notifications, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications).
2222

2323
All calls to these endpoints require the `notifications` or `repo` scopes. You will need the `repo` scope to access issues and commits from their respective endpoints.
2424

content/rest/dependency-graph/sboms.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ allowTitleToDifferFromFilename: true
1616
This article gives details about the REST API endpoint.
1717

1818
{% ifversion ghes %}
19-
{% data variables.product.product_name %} does not retrieve license information for dependencies, and does not calculate information about dependents, the repositories and packages that depend on a repository. These fields will not be populated in the response.
19+
> [!NOTE]
20+
> {% data variables.product.prodname_ghe_server %} does not retrieve license information for dependencies, and does not calculate information about dependents, the repositories and packages that depend on a repository. These fields will not be populated in the response.
2021
{% endif %}
2122

2223
<!-- Content after this section is automatically generated -->

content/rest/enterprise-admin/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,11 @@ http(s)://HOSTNAME:ADMINISTRATION-PORT/
7070

7171
## Authentication
7272

73-
Your {% data variables.product.product_name %} installation's API endpoints accept the same authentication methods as the {% data variables.product.prodname_dotcom %} API. For more information, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api).
73+
Your {% data variables.product.prodname_ghe_server %} installation's API endpoints accept the same authentication methods as the {% data variables.product.github %} API. For more information, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api).
7474

7575
OAuth tokens must have the `site_admin` [OAuth scope](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes) when used with these endpoints.
7676

77-
These endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators, except for endpoints of the [AUTOTITLE](/rest/enterprise-admin/manage-ghes) API{% ifversion ghes < 3.15 %} and [AUTOTITLE](/rest/enterprise-admin/management-console) API{% endif %}, which allow authentication as a Management Console user. See [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console).
77+
These endpoints are only accessible to authenticated {% data variables.product.prodname_ghe_server %} site administrators, except for endpoints of the [AUTOTITLE](/rest/enterprise-admin/manage-ghes) API{% ifversion ghes < 3.15 %} and [AUTOTITLE](/rest/enterprise-admin/management-console) API{% endif %}, which allow authentication as a Management Console user. See [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console).
7878

7979
{% data reusables.enterprise_management_console.api-deprecation %}
8080

content/rest/enterprise-admin/ldap.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ title: REST API endpoints for LDAP
33
shortTitle: LDAP
44
allowTitleToDifferFromFilename: true
55
intro: >-
6-
Use the REST API to update account relationships between a {% data
7-
variables.product.product_name %} user or team and its linked LDAP entry or
6+
Use the REST API to update account relationships between a {% data variables.product.prodname_ghe_server %} user or team and its linked LDAP entry or
87
queue a new synchronization.
98
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
109
ghes: '*'
@@ -15,7 +14,7 @@ autogenerated: rest
1514

1615
## About LDAP
1716

18-
You can use these endpoints to update the Distinguished Name (DN) that a user or team maps to. Note that in most cases, you must have [LDAP Sync enabled](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap) for your {% data variables.product.product_name %} appliance. The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled.
17+
You can use these endpoints to update the Distinguished Name (DN) that a user or team maps to. Note that in most cases, you must have [LDAP Sync enabled](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap) for your {% data variables.product.prodname_ghe_server %} appliance. The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled.
1918

2019
{% data reusables.user-settings.enterprise-admin-api-classic-pat-only %}
2120

content/rest/enterprise-admin/manage-ghes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: REST API endpoints for managing GitHub Enterprise Server
33
allowTitleToDifferFromFilename: true
44
shortTitle: Manage GHES
55
intro: >-
6-
Use the REST API to manage your {% data variables.product.product_name %}
6+
Use the REST API to manage your {% data variables.product.prodname_ghe_server %}
77
instance.
88
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
99
ghes: '*'

content/rest/enterprise-admin/management-console.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: REST API endpoints for Management Console
33
shortTitle: Management Console
44
allowTitleToDifferFromFilename: true
55
intro: >-
6-
Use the REST API to manage your {% data variables.product.product_name %}
6+
Use the REST API to manage your {% data variables.product.prodname_ghe_server %}
77
installation.
88
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
99
ghes: <=3.14
@@ -14,7 +14,7 @@ autogenerated: rest
1414

1515
## About the Management Console endpoints
1616

17-
The full functionality of the Management Console endpoints was added to the [Manage GHES](/rest/enterprise-admin/manage-ghes) endpoints in {% data variables.product.prodname_ghe_server %} version 3.12. With feature parity achieved, the Management Console API endpoints {% ifversion ghes < 3.15 %}will be{% else %}were{% endif %} removed in version 3.15.
17+
The full functionality of the Management Console endpoints was added to the [Manage GHES](/rest/enterprise-admin/manage-ghes) endpoints in {% data variables.product.prodname_ghe_server %} version 3.12. With feature parity achieved, the Management Console API endpoints were removed in version 3.15.
1818

1919
{% ifversion management-console-manage-ghes-parity %}
2020

@@ -42,7 +42,7 @@ You should explicitly set the port number when making API calls to the Managemen
4242

4343
If you cannot provide a port number, you'll need to configure your tool to automatically follow redirects.
4444

45-
You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.product_name %} uses a self-signed certificate before you [add your own TLS certificate](/admin/configuration/configuring-network-settings/configuring-tls).
45+
You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.github %} uses a self-signed certificate before you [add your own TLS certificate](/admin/configuration/configuring-network-settings/configuring-tls).
4646

4747
### Authentication as the root site administrator
4848

0 commit comments

Comments
 (0)