Skip to content

Commit

Permalink
Merge pull request #36025 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Jan 22, 2025
2 parents e0e65e2 + ea44900 commit 3c4b3f7
Show file tree
Hide file tree
Showing 61 changed files with 95 additions and 181 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed assets/images/help/copilot/indexed-repo.png
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ shortTitle: About the monitor {% ifversion ghes > 3.15 %}dashboards{% else %}das
{% data reusables.enterprise_site_admin_settings.management-console %}
1. In the top navigation bar, click **Monitor**.

![Screenshot of the header of the {% data variables.enterprise.management_console %}. A tab, labeled "Monitor", is highlighted with an orange outline.](/assets/images/enterprise/management-console/{% ifversion ghes > 3.15 %}monitor-dash-link.png{% else %}monitor-dash-link-old.png{% endif %})
![Screenshot of the header of the {% data variables.enterprise.management_console %}. A tab, labeled "Monitor", is highlighted with an orange outline.]({% ifversion ghes > 3.15 %}/assets/images/enterprise/management-console/monitor-dash-link.png{% else %}/assets/images/enterprise/management-console/monitor-dash-link-old.png{% endif %})

1. In HA and cluster environments you can switch between nodes using the dropdown and clicking on a different hostname.
{% ifversion ghes > 3.15 %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: About the OpenAPI description for the REST API
shortTitle: OpenAPI description
intro: 'The {% data variables.product.product_name %} REST API is fully described in an OpenAPI compliant document.'
intro: 'The {% data variables.product.github %} REST API is fully described in an OpenAPI compliant document.'
versions:
fpt: '*'
ghes: '*'
Expand Down
2 changes: 1 addition & 1 deletion content/rest/about-the-rest-api/breaking-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ Once your integration is updated, test your integration to verify that it works

## Breaking changes for {{ initialRestVersioningReleaseDate }}

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.
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.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Comparing GitHub's REST API and GraphQL API
shortTitle: Comparing GitHub's APIs
intro: 'Learn about {% data variables.product.prodname_dotcom %}''s APIs to extend and customize your {% data variables.product.prodname_dotcom %} experience.'
intro: 'Learn about {% data variables.product.github %}''s APIs to extend and customize your {% data variables.product.github %} experience.'
redirect_from:
- /v3/versions
- /articles/getting-started-with-the-api
Expand Down Expand Up @@ -29,7 +29,7 @@ This article discusses the benefits of each API. For more information about the

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.

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:
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:

```graphql
{
Expand Down
8 changes: 4 additions & 4 deletions content/rest/activity/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: REST API endpoints for events
shortTitle: Events
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to interact with {% data variables.product.prodname_dotcom %}
Use the REST API to interact with {% data variables.product.github %}
events.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
Expand All @@ -14,11 +14,11 @@ topics:
autogenerated: rest
---

## About {% data variables.product.prodname_dotcom %} events
## About {% data variables.product.github %} events

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

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).
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).

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.

Expand Down
6 changes: 3 additions & 3 deletions content/rest/activity/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: REST API endpoints for notifications
shortTitle: Notifications
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to manage {% data variables.product.product_name %}
Use the REST API to manage {% data variables.product.github %}
notifications.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
Expand All @@ -14,11 +14,11 @@ topics:
autogenerated: rest
---

## About {% data variables.product.product_name %} notifications
## About {% data variables.product.github %} notifications

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

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).
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).

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.

Expand Down
3 changes: 2 additions & 1 deletion content/rest/dependency-graph/sboms.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ allowTitleToDifferFromFilename: true
This article gives details about the REST API endpoint.

{% ifversion ghes %}
{% 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.
> [!NOTE]
> {% 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.
{% endif %}

<!-- Content after this section is automatically generated -->
4 changes: 2 additions & 2 deletions content/rest/enterprise-admin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,11 @@ http(s)://HOSTNAME:ADMINISTRATION-PORT/

## Authentication

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).
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).

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.

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).
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).

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

Expand Down
5 changes: 2 additions & 3 deletions content/rest/enterprise-admin/ldap.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ title: REST API endpoints for LDAP
shortTitle: LDAP
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to update account relationships between a {% data
variables.product.product_name %} user or team and its linked LDAP entry or
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
queue a new synchronization.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghes: '*'
Expand All @@ -15,7 +14,7 @@ autogenerated: rest

## About LDAP

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.
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.

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

Expand Down
2 changes: 1 addition & 1 deletion content/rest/enterprise-admin/manage-ghes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: REST API endpoints for managing GitHub Enterprise Server
allowTitleToDifferFromFilename: true
shortTitle: Manage GHES
intro: >-
Use the REST API to manage your {% data variables.product.product_name %}
Use the REST API to manage your {% data variables.product.prodname_ghe_server %}
instance.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghes: '*'
Expand Down
6 changes: 3 additions & 3 deletions content/rest/enterprise-admin/management-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: REST API endpoints for Management Console
shortTitle: Management Console
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to manage your {% data variables.product.product_name %}
Use the REST API to manage your {% data variables.product.prodname_ghe_server %}
installation.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghes: <=3.14
Expand All @@ -14,7 +14,7 @@ autogenerated: rest

## About the Management Console endpoints

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.
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.

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

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

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

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).
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).

### Authentication as the root site administrator

Expand Down
2 changes: 1 addition & 1 deletion content/rest/enterprise-admin/pre-receive-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ These endpoints are only available to [authenticated](/rest/overview/authenticat
|-----------------------|-----------|----------------------------------------------------------------------------|
| `name` | `string` | The name of the environment as displayed in the UI. |
| `image_url` | `string` | URL to the tarball that will be downloaded and extracted. |
| `default_environment` | `boolean` | Whether this is the default environment that ships with {% data variables.product.product_name %}. |
| `default_environment` | `boolean` | Whether this is the default environment that ships with {% data variables.product.github %}. |
| `download` | `object` | This environment's download status. |
| `hooks_count` | `integer` | The number of pre-receive hooks that use this environment. |

Expand Down
Loading

0 comments on commit 3c4b3f7

Please sign in to comment.