Skip to content

Commit

Permalink
update titles for REST API enterprise-admin, migrations docs (#49378)
Browse files Browse the repository at this point in the history
  • Loading branch information
skedwards88 authored Feb 27, 2024
1 parent be7d68c commit 03038e7
Show file tree
Hide file tree
Showing 34 changed files with 72 additions and 39 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ You can also use a command-line utility to configure the IP exception list. For

## Managing maintenance mode using the REST API

You can manage maintenance mode on {% data variables.location.product_location %} using the REST API. For more information, see "[AUTOTITLE](/rest/enterprise-admin/manage-ghes#get-the-status-of-maintenance-mode)" in the REST API documentation.
You can manage maintenance mode on {% data variables.location.product_location %} using the REST API. For more information, see "[AUTOTITLE](/rest/enterprise-admin/manage-ghes#get-the-status-of-maintenance-mode)."

{% else %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ When you enable one or more security and analysis features for existing reposito
{% ifversion secret-scanning-validity-check-partner-patterns %}
1. Optionally, to automatically allow {% data variables.product.prodname_secret_scanning %} to check the validity of a secret by sending it to the relevant partner, select the relevant checkbox under "{% data variables.product.prodname_secret_scanning_caps %}". You can also enable the validity check for a single repository or organization. For more information, see "[Allowing validity checks for partner patterns in a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#allowing-validity-checks-for-partner-patterns-in-a-repository)," and "[Allowing validity checks for partner patterns in an organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-validity-checks-for-partner-patterns-in-an-organization)."

For information on using the REST API to enable validity checks for partner patterns for your enterprise, see "[AUTOTITLE](/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise)" in the REST API documentation.
For information on using the REST API to enable validity checks for partner patterns for your enterprise, see "[AUTOTITLE](/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise)."

{% data reusables.secret-scanning.validity-check-partner-patterns-beta %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Alternatively, you can use a partner IdP for both authentication and provisionin
- [RFC 7643: Core Schema](https://tools.ietf.org/html/rfc7643)
- [RFC 7644: Protocol](https://tools.ietf.org/html/rfc7644)
- {% data variables.product.company_short %} recommends that you only authenticate requests to the REST API endpoints for SCIM using a {% data variables.product.pat_v1 %} associated with your enterprise's setup user. The token requires the **admin:enterprise** scope. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/provisioning-user-accounts-for-enterprise-managed-users/configuring-scim-provisioning-for-enterprise-managed-users#creating-a-personal-access-token)"
- The user records for the systems that you use for authentication and provisioning must share a unique identifier and satisfy {% data variables.product.company_short %}'s matching criteria. For more information, see "[AUTOTITLE](/rest/enterprise-admin/scim#mapping-of-saml-and-scim-data)" in the REST API documentation.
- The user records for the systems that you use for authentication and provisioning must share a unique identifier and satisfy {% data variables.product.company_short %}'s matching criteria. For more information, see "[AUTOTITLE](/rest/enterprise-admin/scim#mapping-of-saml-and-scim-data)."
- {% data reusables.enterprise_user_management.authentication-or-provisioning-migration-not-supported %}

## Configuring audit log streaming
Expand All @@ -63,7 +63,7 @@ To make SCIM calls and manage users, you'll use {% data variables.product.compan

The following tables describe the SCIM endpoints offered by the REST API. You can read more information in the REST API documentation. The documentation includes code samples, required headers and path parameters, and HTTP response codes.

For more information about authentication of requests to these endpoints, see "[AUTOTITLE](/rest/enterprise-admin/scim#authentication)" in the REST API documentation.
For more information about authentication of requests to these endpoints, see "[AUTOTITLE](/rest/enterprise-admin/scim#authentication)."

Requests that don't match the REST API's expectations will return a `400 Bad Request` error.

Expand Down Expand Up @@ -119,7 +119,7 @@ For example, you can use the `roles` attribute to assign a role in the enterpris

### About mapping of external identities

After successful authentication, {% data variables.product.product_name %} links the user who authenticated to an identity provisioned by SCIM. The unique identifiers for authentication and provisioning must match. For more information, see "[SCIM](/rest/enterprise-admin/scim#mapping-of-saml-and-scim-data)" in the REST API documentation.
After successful authentication, {% data variables.product.product_name %} links the user who authenticated to an identity provisioned by SCIM. The unique identifiers for authentication and provisioning must match. For more information, see "[AUTOTITLE](/rest/enterprise-admin/scim#mapping-of-saml-and-scim-data)."

You can view this mapping on {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To configure provisioning for your enterprise, you must enable provisioning on {

{% ifversion scim-for-ghes %}

The provisioning application on your IdP communicates with {% data variables.product.product_name %} using the SCIM API. For more information, see "[AUTOTITLE](/rest/enterprise-admin/scim)" in the REST API documentation.
The provisioning application on your IdP communicates with {% data variables.product.product_name %} using the SCIM API. For more information, see "[AUTOTITLE](/rest/enterprise-admin/scim)."

{% endif %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ You can request up to 365 days of metrics in a single {% data variables.product.

Before you can use the {% data variables.product.prodname_server_statistics %} REST API, you must enable {% data variables.product.prodname_server_statistics %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)."

For more information about using the REST API to request server statistics, see "[AUTOTITLE](/enterprise-cloud@latest/rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics)" in the {% data variables.product.prodname_ghe_cloud %} REST API documentation.
For more information about using the REST API to request server statistics, see "[AUTOTITLE](/enterprise-cloud@latest/rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics)" in the {% data variables.product.prodname_ghe_cloud %} documentation.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For more information about viewing license usage on {% data variables.product.pr

{% endif %}

You can also use the REST API to return consumed licenses data and the status of the license sync job. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/rest/enterprise-admin/license)" in the REST API documentation.
You can also use the REST API to return consumed licenses data and the status of the license sync job. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/rest/enterprise-admin/license)."

To learn more about the license data associated with your enterprise account and how the number of consumed user {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %} are calculated, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise)."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ For you to use {% data variables.product.prodname_secret_scanning %} as a push p
Organization owners, security managers, and repository administrators can also enable push protection for {% data variables.product.prodname_secret_scanning %} via the API. For more information, see "[AUTOTITLE](/rest/repos#update-a-repository)" and expand the "Properties of the `security_and_analysis` object" section.

{% ifversion secret-scanning-enterprise-level-api %}
Enterprise administrators can also enable or disable {% data variables.product.prodname_secret_scanning %} as a push protection for the enterprise via the API. For more information, see "[AUTOTITLE](/rest/enterprise-admin/code-security-and-analysis)" in the REST API documentation.{% endif %}
Enterprise administrators can also enable or disable {% data variables.product.prodname_secret_scanning %} as a push protection for the enterprise via the API. For more information, see "[AUTOTITLE](/rest/enterprise-admin/code-security-and-analysis)."{% endif %}

{% note %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ The term "source repository" refers to the repository you're importing, and "imp

### About the deprecation of the Source imports REST API

The REST API endpoints to manage source imports allowed the programmatic import of a repositories that are accessible over the internet to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[AUTOTITLE](/rest/migrations/source-imports)" in the REST API documentation.
The REST API endpoints to manage source imports allowed the programmatic import of a repositories that are accessible over the internet to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[AUTOTITLE](/rest/migrations/source-imports)."

On April 12, 2024, {% data variables.product.company_short %} will deprecate all of the endpoints listed within "[AUTOTITLE](/rest/migrations/source-imports)" in the REST API documentation. If you currently use these operations, you'll need to make changes to your code or your application will stop working on April 12, 2024.
On April 12, 2024, {% data variables.product.company_short %} will deprecate all of the endpoints listed within "[AUTOTITLE](/rest/migrations/source-imports)." If you currently use these operations, you'll need to make changes to your code or your application will stop working on April 12, 2024.

## Using forks

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ HTTP/1.1 201 Created
}
```

For more information, see "[Start an organization migration](/rest/migrations/orgs#start-an-organization-migration)" in the REST API documentation.
For more information, see "[Start an organization migration](/rest/migrations/orgs#start-an-organization-migration)."

Generating the archives can take a while, depending on the amount of data. You can regularly check the status of the two migrations with the "Get an organization migration status" API until the `state` of the migration changes to `exported`.

Expand All @@ -205,7 +205,7 @@ Content-Type: application/json
}
```

For more information, see "[Get an organization migration status](/rest/migrations/orgs#get-an-organization-migration-status)" in the REST API documentation.
For more information, see "[Get an organization migration status](/rest/migrations/orgs#get-an-organization-migration-status)".

{% note %}

Expand All @@ -229,7 +229,7 @@ Location: https://media.github.acmecorp.net/migrations/123/archive/cca2ebe9-7403

The API will return a `302 Found` response with a `Location` header redirecting to the URL where the downloadable archive is located. Download the two files: one for the Git source, and one for the metadata.

For more information, see "[Download an organization migration archive](/rest/migrations/orgs#download-an-organization-migration-archive)" in the REST API documentation.
For more information, see "[Download an organization migration archive](/rest/migrations/orgs#download-an-organization-migration-archive)."

After both migrations have completed and you have downloaded the archives, you can move to the next step.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ If their organization uses SAML, organization owners can see each {% data variab

{% ifversion ghes %}

Site administrators can use the REST API to manage {% data variables.product.pat_generic %}s in their enterprise. For more information, see "[AUTOTITLE](/rest/enterprise-admin/users)" in the REST API documentation.
Site administrators can use the REST API to manage {% data variables.product.pat_generic %}s in their enterprise. For more information, see "[AUTOTITLE](/rest/enterprise-admin/users)."

{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ You can restore your backup by decompressing the archive and then pushing the wi

## Backing up a Git repository and selected metadata with migration archives

You can use the REST API to generate a migration archive for a repository. For more information, see "[AUTOTITLE](/rest/migrations/orgs)" in the REST API documentation.
You can use the REST API to generate a migration archive for a repository. For more information, see "[AUTOTITLE](/rest/migrations/orgs)."

These archives are designed for moving data between {% data variables.product.prodname_dotcom %} products, but they can also be used {% ifversion fpt or ghec %}to back up a repository for archiving purposes{% else %} as backups.{% endif %}{% ifversion fpt or ghec or ghes %}

Expand Down
4 changes: 3 additions & 1 deletion content/rest/enterprise-admin/admin-stats.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Admin stats
title: REST API endpoints for admin stats
shortTitle: Admin stats
allowTitleToDifferFromFilename: true
intro: Use the REST API to retrieve a variety of metrics about your installation.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghec: '*'
Expand Down
4 changes: 3 additions & 1 deletion content/rest/enterprise-admin/announcement.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Announcement
title: REST API endpoints for global announcements
shortTitle: Announcement
allowTitleToDifferFromFilename: true
intro: Use the REST API to manage the global announcement banner in your enterprise.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghes: '*'
Expand Down
4 changes: 3 additions & 1 deletion content/rest/enterprise-admin/audit-log.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Audit log
title: REST API endpoints for enterprise audit logs
shortTitle: Audit log
allowTitleToDifferFromFilename: true
intro: Use the REST API to retrieve audit logs for an enterprise.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghec: '*'
Expand Down
4 changes: 3 additions & 1 deletion content/rest/enterprise-admin/billing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Billing
title: REST API endpoints for enterprise billing
shortTitle: Billing
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to retrieve the billing information for a {% data
variables.product.prodname_ghe_server %} instance.
Expand Down
4 changes: 3 additions & 1 deletion content/rest/enterprise-admin/code-security-and-analysis.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Code security and analysis
title: REST API endpoints for enterprise code security and analysis
shortTitle: Code security and analysis
allowTitleToDifferFromFilename: true
intro: Use the REST API to manage code security and analysis features for your enterprise.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghec: '*'
Expand Down
4 changes: 3 additions & 1 deletion content/rest/enterprise-admin/global-webhooks.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Global Webhooks
title: REST API endpoints for global webhooks
shortTitle: Global webhooks
allowTitleToDifferFromFilename: true
intro: Use the REST API to manage global webhooks for your enterprise.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghes: '*'
Expand Down
2 changes: 1 addition & 1 deletion content/rest/enterprise-admin/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: GitHub Enterprise administration
title: REST API endpoints for GitHub Enterprise administration
intro: Use the REST API to administer your enterprise.
allowTitleToDifferFromFilename: true
redirect_from:
Expand Down
4 changes: 3 additions & 1 deletion content/rest/enterprise-admin/ldap.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: LDAP
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
Expand Down
4 changes: 3 additions & 1 deletion content/rest/enterprise-admin/license.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: License
title: REST API endpoints for enterprise licenses
shortTitle: License
allowTitleToDifferFromFilename: true
intro: Use the REST API to retrieve information about your Enterprise license.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghec: '*'
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
@@ -1,5 +1,5 @@
---
title: Manage GitHub Enterprise Server
title: REST API endpoints for managing GitHub Enterprise Server
allowTitleToDifferFromFilename: true
shortTitle: Manage GHES
intro: >-
Expand Down
4 changes: 3 additions & 1 deletion content/rest/enterprise-admin/management-console.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Management Console
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 %}
installation.
Expand Down
3 changes: 2 additions & 1 deletion content/rest/enterprise-admin/org-pre-receive-hooks.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Organization Pre-receive Hooks
title: REST API endpoints for organization pre-receive hooks
shortTitle: Organization pre-receive hooks
intro: >-
Use the REST API to view and modify enforcement of the pre-receive hooks that
are available to an organization.
Expand Down
3 changes: 2 additions & 1 deletion content/rest/enterprise-admin/orgs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Organizations
title: REST API endpoints for enterprise organizations
shortTitle: Organizations
intro: Use the REST API to create organizations on your enterprise.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghes: '*'
Expand Down
4 changes: 3 additions & 1 deletion content/rest/enterprise-admin/pre-receive-environments.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Pre-receive Environments
title: REST API endpoints for pre-receive environments
shortTitle: Pre-receive environments
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to create, list, update and delete environments for
pre-receive hooks.
Expand Down
4 changes: 3 additions & 1 deletion content/rest/enterprise-admin/pre-receive-hooks.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Pre-receive Hooks
title: REST API endpoints for pre-receive hooks
shortTitle: Pre-receive hooks
allowTitleToDifferFromFilename: true
intro: 'Use the REST API to create, list, update and delete pre-receive hooks.'
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghes: '*'
Expand Down
3 changes: 2 additions & 1 deletion content/rest/enterprise-admin/repo-pre-receive-hooks.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Repository Pre-receive Hooks
title: REST API endpoints for repository pre-receive hooks
shortTitle: Repository pre-receive hooks
intro: >-
Use the REST API to view and modify enforcement of the pre-receive hooks that
are available to a repository.
Expand Down
4 changes: 3 additions & 1 deletion content/rest/enterprise-admin/scim.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: SCIM
title: REST API endpoints for SCIM
shortTitle: SCIM
allowTitleToDifferFromFilename: true
intro: Use the REST API to automate user creation and team memberships with SCIM.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghec: '*'
Expand Down
4 changes: 3 additions & 1 deletion content/rest/enterprise-admin/users.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Users
title: REST API endpoints for enterprise users
shortTitle: Users
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to suspend{% ifversion ghes %}, unsuspend, promote, and
demote{% endif %} users on your enterprise.
Expand Down
4 changes: 3 additions & 1 deletion content/rest/migrations/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Migrations
title: REST API endpoints for migrations
shortTitle: Migrations
allowTitleToDifferFromFilename: true
intro: 'Use the REST API to migrate the repositories and users of your organization from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}.'
redirect_from:
- /v3/migrations
Expand Down
2 changes: 1 addition & 1 deletion content/rest/migrations/orgs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Organization migrations
title: REST API endpoints for organization migrations
allowTitleToDifferFromFilename: true
shortTitle: Organizations
intro: >-
Expand Down
4 changes: 3 additions & 1 deletion content/rest/migrations/source-imports.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Source imports
title: REST API endpoints for source imports
shortTitle: Source endpoints
allowTitleToDifferFromFilename: true
intro: >-
Use the REST API to start an import from a Git, Subversion, Mercurial, or Team
Foundation Version Control source repository.
Expand Down
2 changes: 1 addition & 1 deletion content/rest/migrations/users.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: User migrations
title: REST API endpoints for user migrations
allowTitleToDifferFromFilename: true
shortTitle: Users
intro: >-
Expand Down
2 changes: 1 addition & 1 deletion data/reusables/release-notes/manage-api-unreachable.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ sudo chown -R ghes-manage-gateway:ghes-manage-gateway /data/ghes-manage-gateway/
sudo systemctl restart ghes-manage-gateway ghes-manage-gateway-consul
```

For more information about the Manage GitHub Enterprise Server API, see "[Manage GitHub Enterprise Server](/rest/enterprise-admin/manage-ghes?apiVersion=2022-11-28)" in the REST API documentation.
For more information about the Manage GitHub Enterprise Server API, see "[Manage GitHub Enterprise Server](/rest/enterprise-admin/manage-ghes?apiVersion=2022-11-28)."

0 comments on commit 03038e7

Please sign in to comment.