From 7b168cc4224b42047ab678ef334da13064ac39fd Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 2 Nov 2026 10:10:50 +0000 Subject: [PATCH 1/2] Update OpenAPI Description (#64495) Co-authored-by: subatoi <32935794+subatoi@users.noreply.github.com> --- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/users.json | 4 ++-- src/rest/data/fpt-2026-03-10/users.json | 4 ++-- src/rest/data/ghec-2022-11-28/users.json | 4 ++-- src/rest/data/ghec-2026-03-10/users.json | 4 ++-- src/rest/data/ghes-3.18-2022-11-28/users.json | 4 ++-- src/rest/data/ghes-3.19-2022-11-28/users.json | 4 ++-- src/rest/data/ghes-3.20-2022-11-28/users.json | 4 ++-- src/rest/data/ghes-3.21-2022-11-28/users.json | 4 ++-- src/rest/data/ghes-3.21-2026-03-10/users.json | 4 ++-- src/rest/data/ghes-3.22-2022-11-28/users.json | 4 ++-- src/rest/data/ghes-3.22-2026-03-10/users.json | 4 ++-- src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 14 files changed, 25 insertions(+), 25 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index ccac9357558d..84c651f6580a 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "c66e298030d4070b70a569dcd4268b3a041b5380" + "sha": "320307e220815d528224ca891cf8a9e3c0243678" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/users.json b/src/rest/data/fpt-2022-11-28/users.json index e2ec029da94f..d7c69a661817 100644 --- a/src/rest/data/fpt-2022-11-28/users.json +++ b/src/rest/data/fpt-2022-11-28/users.json @@ -9,7 +9,7 @@ "subcategory": "users", "parameters": [], "bodyParameters": [], - "descriptionHTML": "
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
OAuth app tokens and personal access tokens (classic) need the read:user scope, or the broader user scope, for this endpoint to return the private user response. The private user response includes additional fields such as private_gists, total_private_repos, owned_private_repos, disk_usage, collaborators, and two_factor_authentication. Tokens without these scopes receive the public user response.
The private and public user response types are unrelated to the private profile setting. A token without scopes still authenticates as the token's owner, so values subject to private profile visibility, such as followers and following, may differ from an unauthenticated response.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
Lists all of your email addresses, and specifies which one is visible\nto the public.
\nOAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.
For enterprise-managed users, if their email is unverified, this endpoint will return a placeholder email in the format email+shortcode@domain.com instead of their actual email. This placeholder email may cause issues with some third-party apps. Once the user has verified their email address, the endpoint will return their real email.